This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Group Member list

1 - 1.4

get /v1/groups/{group_id}/members

Description

Group Member list

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathgroup_id
required		Group ID
Example : a946662dc4314dac93da413a32457459
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryuser_name
optional		Group Member Last Name, First Name
Example : Kim Samsung
any of [string, null]None
queryuser_email
optional		Group Member Email
Example : samsung.kim@samsung.com
any of [string, null]None
querycreator_name
optional		Creator Last Name, First Name
Example : Kim Samsung
any of [string, null]None
querycreator_email
optional		Creator Email
Example : samsung.kim@samsung.com
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKGroupMemberPageResponseV1Dot4
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/groups/{group_id}/members

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.4"

Example HTTP response

Response 200

{
    "count": 20,
    "group_members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "creator_created_at": "2024-05-17T00:23:17Z",
            "creator_email": "samsung.kim@samsung.com",
            "creator_last_login_at": "2024-05-17T00:23:17Z",
            "creator_name": "Kim Samsung",
            "groups": [
                {
                    "id": "a946662dc4314dac93da413a32457459",
                    "name": "TestGroup"
                }
            ],
            "user_created_at": "2024-05-17T00:23:17Z",
            "user_email": "samsung.kim@samsung.com",
            "user_id": "f39c460fade34fecb05ede8f904b24b7",
            "user_last_login_at": "2024-05-17T00:23:17Z",
            "user_name": "Kim Samsung"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2 - 1.3

get /v1/groups/{group_id}/members

Description

Group Member list

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261130

Parameters

TypeNameDescriptionSchemaDefault
pathgroup_id
required		Group ID
Example : a946662dc4314dac93da413a32457459
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryuser_name
optional		Group Member Last Name, First Name
Example : Kim Samsung
any of [string, null]None
queryuser_email
optional		Group Member Email
Example : samsung.kim@samsung.com
any of [string, null]None
querycreator_name
optional		Creator Last Name, First Name
Example : Kim Samsung
any of [string, null]None
querycreator_email
optional		Creator Email
Example : samsung.kim@samsung.com
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKGroupMemberPageResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/groups/{group_id}/members

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "group_members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "creator_created_at": "2024-05-17T00:23:17Z",
            "creator_email": "samsung.kim@samsung.com",
            "creator_last_login_at": "2024-05-17T00:23:17Z",
            "creator_name": "Kim Samsung",
            "group_names": [
                "TestGroup",
                "SampleGroup"
            ],
            "user_created_at": "2024-05-17T00:23:17Z",
            "user_email": "samsung.kim@samsung.com",
            "user_id": "f39c460fade34fecb05ede8f904b24b7",
            "user_last_login_at": "2024-05-17T00:23:17Z",
            "user_name": "Kim Samsung"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3 - 1.2

get /v1/groups/{group_id}/members

Description

Group Member list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

TypeNameDescriptionSchemaDefault
pathgroup_id
required		Group ID
Example : a946662dc4314dac93da413a32457459
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryuser_name
optional		Group Member Last Name, First Name
Example : Kim Samsung
any of [string, null]None
queryuser_email
optional		Group Member Email
Example : samsung.kim@samsung.com
any of [string, null]None
querycreator_name
optional		Creator Last Name, First Name
Example : Kim Samsung
any of [string, null]None
querycreator_email
optional		Creator Email
Example : samsung.kim@samsung.com
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKGroupMemberPageResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/groups/{group_id}/members

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "group_members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "creator_created_at": "2024-05-17T00:23:17Z",
            "creator_email": "samsung.kim@samsung.com",
            "creator_last_login_at": "2024-05-17T00:23:17Z",
            "creator_name": "Kim Samsung",
            "group_names": [
                "TestGroup",
                "SampleGroup"
            ],
            "user_created_at": "2024-05-17T00:23:17Z",
            "user_email": "samsung.kim@samsung.com",
            "user_id": "f39c460fade34fecb05ede8f904b24b7",
            "user_last_login_at": "2024-05-17T00:23:17Z",
            "user_name": "Kim Samsung"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

4 - 1.1

get /v1/groups/{group_id}/members

Description

Group Member list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

TypeNameDescriptionSchemaDefault
pathgroup_id
required		Group ID
Example : a946662dc4314dac93da413a32457459
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryuser_name
optional		Group Member Last Name, First Name
Example : Kim Samsung
any of [string, null]None
queryuser_email
optional		Group Member Email
Example : samsung.kim@samsung.com
any of [string, null]None
querycreator_name
optional		Creator Last Name, First Name
Example : Kim Samsung
any of [string, null]None
querycreator_email
optional		Creator Email
Example : samsung.kim@samsung.com
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKGroupMemberPageResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/groups/{group_id}/members

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "group_members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "creator_created_at": "2024-05-17T00:23:17Z",
            "creator_email": "samsung.kim@samsung.com",
            "creator_last_login_at": "2024-05-17T00:23:17Z",
            "creator_name": "Kim Samsung",
            "group_names": [
                "TestGroup",
                "SampleGroup"
            ],
            "user_created_at": "2024-05-17T00:23:17Z",
            "user_email": "samsung.kim@samsung.com",
            "user_id": "f39c460fade34fecb05ede8f904b24b7",
            "user_last_login_at": "2024-05-17T00:23:17Z",
            "user_name": "Kim Samsung"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5 - 1.0

get /v1/groups/{group_id}/members

Description

Group Member list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

TypeNameDescriptionSchemaDefault
pathgroup_id
required		Group ID
Example : a946662dc4314dac93da413a32457459
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryuser_name
optional		Group Member Last Name, First Name
Example : Kim Samsung
any of [string, null]None
queryuser_email
optional		Group Member Email
Example : samsung.kim@samsung.com
any of [string, null]None
querycreator_name
optional		Creator Last Name, First Name
Example : Kim Samsung
any of [string, null]None
querycreator_email
optional		Creator Email
Example : samsung.kim@samsung.com
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKGroupMemberPageResponse
400Bad RequestNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/groups/{group_id}/members

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "group_members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "creator_created_at": "2024-05-17T00:23:17Z",
            "creator_email": "samsung.kim@samsung.com",
            "creator_last_login_at": "2024-05-17T00:23:17Z",
            "creator_name": "Kim Samsung",
            "group_names": [
                "TestGroup",
                "SampleGroup"
            ],
            "user_created_at": "2024-05-17T00:23:17Z",
            "user_email": "samsung.kim@samsung.com",
            "user_id": "f39c460fade34fecb05ede8f904b24b7",
            "user_last_login_at": "2024-05-17T00:23:17Z",
            "user_name": "Kim Samsung"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}