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

Return to the regular view of this page.

List Groups

1: 1.4
2: 1.3
3: 1.2
4: 1.1
5: 1.0

1 - 1.4

get /v1/groups

Description

List Groups

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Group Name Example : `TestGroup`	any of [string, null]	None
query	types optional	Group Types Example : `USER_DEFINED,DEFAULT`	any of [string, null]	None
query	ids optional	Group ID List Example : `629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765`	any of [string, null]	None
query	has_member optional	Group Member Existence Example : `false`	any of [boolean, null]	None
query	has_role optional	Group Role Existence Example : `false`	any of [boolean, null]	None
query	is_completed optional	Group Completion Status Example : `false`	any of [boolean, null]	None
query	creator_name optional	Creator Last Name, First Name Example : `Kim Samsung`	any of [string, null]	None
query	creator_email optional	Creator Email Example : `samsung.kim@samsung.com`	any of [string, null]	None
query	modifier_name optional	Modifier Last Name, First Name Example : `Kim Samsung`	any of [string, null]	None
query	modifier_email optional	Modifier Email Example : `samsung.kim@samsung.com`	any of [string, null]	None
query	exclude_user_id optional	User ID to Exclude Example : `f39c460fade34fecb05ede8f904b24b7`	any of [string, null]	None
query	exclude_policy_id optional	Policy ID to Exclude Example : `37f2e31ff86b415698d7e8eeafab445d`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	GroupPageResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/groups

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,
    "groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "creator_email": "samsung.kim@samsung.com",
            "creator_name": "Kim Samsung",
            "description": "Descriptions for group",
            "domain_name": "scp",
            "id": "f39c460fade34fecb05ede8f904b24b7",
            "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"
                }
            ],
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "modifier_email": "samsung.kim@samsung.com",
            "modifier_name": "Kim Samsung",
            "name": "TestGroup",
            "policies": [],
            "resource_type": "group",
            "roles": [],
            "service_name": "Identity Access Management",
            "service_type": "iam",
            "srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
            "type": "USER_DEFINED"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2 - 1.3

get /v1/groups

Description

List Groups

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Group Name Example : `TestGroup`	any of [string, null]	None
query	types optional	Group Types Example : `USER_DEFINED,DEFAULT`	any of [string, null]	None
query	ids optional	Group ID List Example : `629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765`	any of [string, null]	None
query	has_member optional	Group Member Existence Example : `false`	any of [string, null]	None
query	has_role optional	Group Role Existence Example : `false`	any of [string, null]	None
query	is_completed optional	Group Completion Status Example : `false`	any of [string, null]	None
query	creator_name optional	Creator Last Name, First Name Example : `Kim Samsung`	any of [string, null]	None
query	creator_email optional	Creator Email Example : `samsung.kim@samsung.com`	any of [string, null]	None
query	modifier_name optional	Modifier Last Name, First Name Example : `Kim Samsung`	any of [string, null]	None
query	modifier_email optional	Modifier Email Example : `samsung.kim@samsung.com`	any of [string, null]	None
query	exclude_user_id optional	User ID to Exclude Example : `f39c460fade34fecb05ede8f904b24b7`	any of [string, null]	None
query	exclude_policy_id optional	Policy ID to Exclude Example : `37f2e31ff86b415698d7e8eeafab445d`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	GroupPageResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/groups

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,
    "groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "creator_email": "samsung.kim@samsung.com",
            "creator_name": "Kim Samsung",
            "description": "Descriptions for group",
            "domain_name": "scp",
            "id": "f39c460fade34fecb05ede8f904b24b7",
            "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"
                }
            ],
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "modifier_email": "samsung.kim@samsung.com",
            "modifier_name": "Kim Samsung",
            "name": "TestGroup",
            "policies": [],
            "resource_type": "group",
            "roles": [],
            "service_name": "Identity Access Management",
            "service_type": "iam",
            "srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
            "type": "USER_DEFINED"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3 - 1.2

get /v1/groups

Description

List Groups

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Group Name Example : `TestGroup`	any of [string, null]	None
query	types optional	Group Types Example : `USER_DEFINED,DEFAULT`	any of [string, null]	None
query	ids optional	Group ID List Example : `629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765`	any of [string, null]	None
query	has_member optional	Group Member Existence Example : `false`	any of [string, null]	None
query	has_role optional	Group Role Existence Example : `false`	any of [string, null]	None
query	is_completed optional	Group Completion Status Example : `false`	any of [string, null]	None
query	creator_name optional	Creator Last Name, First Name Example : `Kim Samsung`	any of [string, null]	None
query	creator_email optional	Creator Email Example : `samsung.kim@samsung.com`	any of [string, null]	None
query	modifier_name optional	Modifier Last Name, First Name Example : `Kim Samsung`	any of [string, null]	None
query	modifier_email optional	Modifier Email Example : `samsung.kim@samsung.com`	any of [string, null]	None
query	exclude_user_id optional	User ID to Exclude Example : `f39c460fade34fecb05ede8f904b24b7`	any of [string, null]	None
query	exclude_policy_id optional	Policy ID to Exclude Example : `37f2e31ff86b415698d7e8eeafab445d`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	GroupPageResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/groups

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,
    "groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "creator_email": "samsung.kim@samsung.com",
            "creator_name": "Kim Samsung",
            "description": "Descriptions for group",
            "domain_name": "scp",
            "id": "f39c460fade34fecb05ede8f904b24b7",
            "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"
                }
            ],
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "modifier_email": "samsung.kim@samsung.com",
            "modifier_name": "Kim Samsung",
            "name": "TestGroup",
            "policies": [],
            "resource_type": "group",
            "roles": [],
            "service_name": "Identity Access Management",
            "service_type": "iam",
            "srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
            "type": "USER_DEFINED"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

4 - 1.1

get /v1/groups

Description

List Groups

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260531

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Group Name Example : `TestGroup`	any of [string, null]	None
query	types optional	Group Types Example : `USER_DEFINED,DEFAULT`	any of [string, null]	None
query	ids optional	Group ID List Example : `629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765`	any of [string, null]	None
query	has_member optional	Group Member Existence Example : `false`	any of [string, null]	None
query	has_role optional	Group Role Existence Example : `false`	any of [string, null]	None
query	is_completed optional	Group Completion Status Example : `false`	any of [string, null]	None
query	creator_name optional	Creator Last Name, First Name Example : `Kim Samsung`	any of [string, null]	None
query	creator_email optional	Creator Email Example : `samsung.kim@samsung.com`	any of [string, null]	None
query	modifier_name optional	Modifier Last Name, First Name Example : `Kim Samsung`	any of [string, null]	None
query	modifier_email optional	Modifier Email Example : `samsung.kim@samsung.com`	any of [string, null]	None
query	exclude_user_id optional	User ID to Exclude Example : `f39c460fade34fecb05ede8f904b24b7`	any of [string, null]	None
query	exclude_policy_id optional	Policy ID to Exclude Example : `37f2e31ff86b415698d7e8eeafab445d`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	GroupPageResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/groups

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,
    "groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "creator_email": "samsung.kim@samsung.com",
            "creator_name": "Kim Samsung",
            "description": "Descriptions for group",
            "domain_name": "scp",
            "id": "f39c460fade34fecb05ede8f904b24b7",
            "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"
                }
            ],
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "modifier_email": "samsung.kim@samsung.com",
            "modifier_name": "Kim Samsung",
            "name": "TestGroup",
            "policies": [],
            "resource_type": "group",
            "roles": [],
            "service_name": "Identity Access Management",
            "service_type": "iam",
            "srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
            "type": "USER_DEFINED"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5 - 1.0

get /v1/groups

Description

List Groups

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260223

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Group Name Example : `TestGroup`	any of [string, null]	None
query	types optional	Group Types Example : `USER_DEFINED,DEFAULT`	any of [string, null]	None
query	ids optional	Group ID List Example : `629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765`	any of [string, null]	None
query	has_member optional	Group Member Existence Example : `false`	any of [string, null]	None
query	has_role optional	Group Role Existence Example : `false`	any of [string, null]	None
query	is_completed optional	Group Completion Status Example : `false`	any of [string, null]	None
query	creator_name optional	Creator Last Name, First Name Example : `Kim Samsung`	any of [string, null]	None
query	creator_email optional	Creator Email Example : `samsung.kim@samsung.com`	any of [string, null]	None
query	modifier_name optional	Modifier Last Name, First Name Example : `Kim Samsung`	any of [string, null]	None
query	modifier_email optional	Modifier Email Example : `samsung.kim@samsung.com`	any of [string, null]	None
query	exclude_user_id optional	User ID to Exclude Example : `f39c460fade34fecb05ede8f904b24b7`	any of [string, null]	None
query	exclude_policy_id optional	Policy ID to Exclude Example : `37f2e31ff86b415698d7e8eeafab445d`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	GroupPageResponse
400	Bad Request	None
401	Unauthorized	None
404	Not Found	None

Example HTTP request

Request path

/v1/groups

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,
    "groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "creator_email": "samsung.kim@samsung.com",
            "creator_name": "Kim Samsung",
            "description": "Descriptions for group",
            "domain_name": "scp",
            "id": "f39c460fade34fecb05ede8f904b24b7",
            "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"
                }
            ],
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
            "modifier_email": "samsung.kim@samsung.com",
            "modifier_name": "Kim Samsung",
            "name": "TestGroup",
            "policies": [],
            "resource_type": "group",
            "roles": [],
            "service_name": "Identity Access Management",
            "service_type": "iam",
            "srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
            "type": "USER_DEFINED"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}