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

Return to the regular view of this page.

ListGroups

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

1 - 1.4

get /v1/groups

Description

get groups list

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	instance_id required	Instance ID Example : `ssoins-12345`	string	None
query	name optional	Group Name Example : `Admin_Group`	any of [string, null]	None
query	excluded_user_uuid optional	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	any of [string, null]	None
query	excluded_account_id optional	Account ID Example : `1234ab567cd64769e8f9g490hi304891`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/groups?instance_id={instance_id}

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-identity-center 1.4"

Example HTTP response

Response 200

{
    "count": 20,
    "groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "creator_name": "John Doe",
            "description": "Group for administrators",
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "instance_id": "ssoins-12345",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modifier_name": "Smith",
            "name": "Admin_Group",
            "user_count": 1,
            "users": [
                {
                    "id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
                    "name": "John Doe",
                    "user_id": "johndoe"
                }
            ]
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2 - 1.3

get /v1/groups

Description

get groups list

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	instance_id required	Instance ID Example : `ssoins-12345`	string	None
query	name optional	Group Name Example : `Admin_Group`	any of [string, null]	None
query	excluded_user_uuid optional	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	any of [string, null]	None
query	excluded_account_id optional	Account ID Example : `1234ab567cd64769e8f9g490hi304891`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/groups?instance_id={instance_id}

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-identity-center 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "creator_name": "John Doe",
            "description": "Group for administrators",
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "instance_id": "ssoins-12345",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modifier_name": "Smith",
            "name": "Admin_Group",
            "user_count": 1,
            "users": [
                {
                    "id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
                    "name": "John Doe",
                    "user_id": "johndoe"
                }
            ]
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3 - 1.2

get /v1/groups

Description

get groups list

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	instance_id required	Instance ID Example : `ssoins-12345`	string	None
query	name optional	Group Name Example : `Admin_Group`	any of [string, null]	None
query	excluded_user_uuid optional	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	any of [string, null]	None
query	excluded_account_id optional	Account ID Example : `1234ab567cd64769e8f9g490hi304891`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/groups?instance_id={instance_id}

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-identity-center 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "creator_name": "John Doe",
            "description": "Group for administrators",
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "instance_id": "ssoins-12345",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modifier_name": "Smith",
            "name": "Admin_Group",
            "user_count": 1,
            "users": [
                {
                    "id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
                    "name": "John Doe",
                    "user_id": "johndoe"
                }
            ]
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

4 - 1.1

get /v1/groups

Description

get groups 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.

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	instance_id required	Instance ID Example : `ssoins-12345`	string	None
query	name optional	Group Name Example : `Admin_Group`	any of [string, null]	None
query	excluded_user_uuid optional	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	any of [string, null]	None
query	excluded_account_id optional	Account ID Example : `1234ab567cd64769e8f9g490hi304891`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/groups?instance_id={instance_id}

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-identity-center 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "creator_name": "John Doe",
            "description": "Group for administrators",
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "instance_id": "ssoins-12345",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modifier_name": "Smith",
            "name": "Admin_Group",
            "user_count": 1,
            "users": [
                {
                    "id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
                    "name": "John Doe",
                    "user_id": "johndoe"
                }
            ]
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5 - 1.0

get /v1/groups

Description

get groups 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.

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	instance_id required	Instance ID Example : `ssoins-12345`	string	None
query	name optional	Group Name Example : `Admin_Group`	any of [string, null]	None
query	excluded_user_uuid optional	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	any of [string, null]	None
query	excluded_account_id optional	Account ID Example : `1234ab567cd64769e8f9g490hi304891`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/groups?instance_id={instance_id}

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-identity-center 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "creator_name": "John Doe",
            "description": "Group for administrators",
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "instance_id": "ssoins-12345",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modifier_name": "Smith",
            "name": "Admin_Group",
            "user_count": 1,
            "users": [
                {
                    "id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
                    "name": "John Doe",
                    "user_id": "johndoe"
                }
            ]
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}