"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"

Request body

{
    "accounts": [
        {
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "target_account@example.com"
        }
    ],
    "instance_id": "ssoins-12345",
    "permission_sets": [
        {
            "custom_policies": [],
            "inline_policies": [],
            "managed_policies": [],
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "permission_set_name": "Permission Set",
            "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "session_duration": 3600
        }
    ],
    "principals": [
        {
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER"
        }
    ]
}

Example HTTP response

Response 201

{
    "account_assignments": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

1.2 - 1.3

post /v1/account-assignments

Description

set a specific account Assignment

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
body	body required		AccountAssignmentsCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
201	Created	AccountAssignmentsCreateResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/account-assignments

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"

Request body

{
    "accounts": [
        {
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "target_account@example.com"
        }
    ],
    "instance_id": "ssoins-12345",
    "permission_sets": [
        {
            "custom_policies": [],
            "inline_policies": [],
            "managed_policies": [],
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "permission_set_name": "Permission Set",
            "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "session_duration": 3600
        }
    ],
    "principals": [
        {
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER"
        }
    ]
}

Example HTTP response

Response 201

{
    "account_assignments": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

1.3 - 1.2

post /v1/account-assignments

Description

set a specific account Assignment

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
body	body required		AccountAssignmentsCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
201	Created	AccountAssignmentsCreateResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/account-assignments

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"

Request body

{
    "accounts": [
        {
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "target_account@example.com"
        }
    ],
    "instance_id": "ssoins-12345",
    "permission_sets": [
        {
            "custom_policies": [],
            "inline_policies": [],
            "managed_policies": [],
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "permission_set_name": "Permission Set",
            "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "session_duration": 3600
        }
    ],
    "principals": [
        {
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER"
        }
    ]
}

Example HTTP response

Response 201

{
    "account_assignments": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

1.4 - 1.1

post /v1/account-assignments

Description

set a specific account Assignment

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
body	body required		AccountAssignmentsCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AccountAssignmentsCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/account-assignments

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"

Request body

{
    "accounts": [
        {
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "target_account@example.com"
        }
    ],
    "instance_id": "ssoins-12345",
    "permission_sets": [
        {
            "customer_policies": [],
            "inline_policies": [],
            "managed_policies": [],
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "permission_set_name": "Permission Set",
            "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "session_duration": 3600
        }
    ],
    "principals": [
        {
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER"
        }
    ]
}

Example HTTP response

Response 201

{
    "account_assignment_id": "b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8",
    "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
    "principal_type": "USER",
    "role_srn": "Permissions for administrators",
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

1.5 - 1.0

post /v1/account-assignments

Description

set a specific account Assignment

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
body	body required		AccountAssignmentsCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AccountAssignmentsCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/account-assignments

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"

Request body

{
    "accounts": [
        {
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "target_account@example.com"
        }
    ],
    "instance_id": "ssoins-12345",
    "permission_sets": [
        {
            "customer_policies": [],
            "inline_policies": [],
            "managed_policies": [],
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "permission_set_name": "Permission Set",
            "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "session_duration": 3600
        }
    ],
    "principals": [
        {
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER"
        }
    ]
}

Example HTTP response

Response 201

{
    "account_assignment_id": "b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8",
    "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
    "principal_type": "USER",
    "role_srn": "Permissions for administrators",
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

2 - CreateBulkGroupUsers

2.1 - 1.4

post /v1/groups/{group_id}/users

Description

add multiple users to a specific group

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupUsersRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "group": {
        "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"
            }
        ]
    }
}

2.2 - 1.3

post /v1/groups/{group_id}/users

Description

add multiple users to a specific group

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupUsersRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "group": {
        "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"
            }
        ]
    }
}

2.3 - 1.2

post /v1/groups/{group_id}/users

Description

add multiple users to a specific group

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupUsersRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "group": {
        "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"
            }
        ]
    }
}

2.4 - 1.1

post /v1/groups/{group_id}/users

Description

add multiple users to a specific group

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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupUsersRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "group": {
        "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"
            }
        ]
    }
}

2.5 - 1.0

post /v1/groups/{group_id}/users

Description

add multiple users to a specific group

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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupUsersRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "group": {
        "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"
            }
        ]
    }
}

3 - CreateGroup

3.1 - 1.4

post /v1/groups

Description

create a group

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		GroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	GroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	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-identity-center 1.4"

Request body

{
    "description": "Group for administrators",
    "instance_id": "ssoins-12345",
    "name": "Admin_Group",
    "user_uuids": [
        "138c2fc8c29a449dbfa8681f8f1d78e2"
    ]
}

Example HTTP response

Response 201

{
    "group": {
        "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"
            }
        ]
    }
}

3.2 - 1.3

post /v1/groups

Description

create a group

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
body	body required		GroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	GroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	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-identity-center 1.3"

Request body

{
    "description": "Group for administrators",
    "instance_id": "ssoins-12345",
    "name": "Admin_Group",
    "user_uuids": [
        "138c2fc8c29a449dbfa8681f8f1d78e2"
    ]
}

Example HTTP response

Response 201

{
    "group": {
        "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"
            }
        ]
    }
}

3.3 - 1.2

post /v1/groups

Description

create a group

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
body	body required		GroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	GroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	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-identity-center 1.2"

Request body

{
    "description": "Group for administrators",
    "instance_id": "ssoins-12345",
    "name": "Admin_Group",
    "user_uuids": [
        "138c2fc8c29a449dbfa8681f8f1d78e2"
    ]
}

Example HTTP response

Response 201

{
    "group": {
        "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"
            }
        ]
    }
}

3.4 - 1.1

post /v1/groups

Description

create a group

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
body	body required		GroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	GroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	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-identity-center 1.1"

Request body

{
    "description": "Group for administrators",
    "instance_id": "ssoins-12345",
    "name": "Admin_Group",
    "user_uuids": [
        "138c2fc8c29a449dbfa8681f8f1d78e2"
    ]
}

Example HTTP response

Response 201

{
    "group": {
        "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"
            }
        ]
    }
}

3.5 - 1.0

post /v1/groups

Description

create a group

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
body	body required		GroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	GroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	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-identity-center 1.0"

Request body

{
    "description": "Group for administrators",
    "instance_id": "ssoins-12345",
    "name": "Admin_Group",
    "user_uuids": [
        "138c2fc8c29a449dbfa8681f8f1d78e2"
    ]
}

Example HTTP response

Response 201

{
    "group": {
        "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"
            }
        ]
    }
}

4 - CreateInstance

4.1 - 1.4

post /v1/instances

Description

create a instance

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		InstanceCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	InstanceShowResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/instances

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"

Request body

{
    "description": "My Instance Description",
    "identity_store_config": {
        "bind_credential": "password",
        "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
        "connection_url": "ldaps://test.subdomain.company.com:123",
        "rdn_ldap_attribute": "cn",
        "user_object_classes": "person, organizationalPerson, user",
        "username_ldap_attribute": "sAMAccountName",
        "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
    },
    "identity_store_type": "ACTIVE_DIRECTORY",
    "name": "My Instance"
}

Example HTTP response

Response 201

{
    "instance": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "region": "kr-west1",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

4.2 - 1.3

post /v1/instances

Description

create a instance

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
body	body required		InstanceCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	InstanceShowResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/instances

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"

Request body

{
    "description": "My Instance Description",
    "identity_store_config": {
        "bind_credential": "password",
        "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
        "connection_url": "ldaps://test.subdomain.company.com:123",
        "rdn_ldap_attribute": "cn",
        "user_object_classes": "person, organizationalPerson, user",
        "username_ldap_attribute": "sAMAccountName",
        "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
    },
    "identity_store_type": "ACTIVE_DIRECTORY",
    "name": "My Instance"
}

Example HTTP response

Response 201

{
    "instance": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "region": "kr-west1",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

4.3 - 1.2

post /v1/instances

Description

create a instance

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
body	body required		InstanceCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	InstanceShowResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/instances

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"

Request body

{
    "description": "My Instance Description",
    "identity_store_config": {
        "bind_credential": "password",
        "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
        "connection_url": "ldaps://test.subdomain.company.com:123",
        "rdn_ldap_attribute": "cn",
        "user_object_classes": "person, organizationalPerson, user",
        "username_ldap_attribute": "sAMAccountName",
        "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
    },
    "identity_store_type": "ACTIVE_DIRECTORY",
    "name": "My Instance"
}

Example HTTP response

Response 201

{
    "instance": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "region": "kr-west1",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

4.4 - 1.1

post /v1/instances

Description

create a instance

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
body	body required		InstanceCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	InstanceShowResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/instances

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"

Request body

{
    "description": "My Instance Description",
    "identity_store_config": {
        "bind_credential": "password",
        "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
        "connection_url": "ldaps://test.subdomain.company.com:123",
        "rdn_ldap_attribute": "cn",
        "user_object_classes": "person, organizationalPerson, user",
        "username_ldap_attribute": "sAMAccountName",
        "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
    },
    "identity_store_type": "ACTIVE_DIRECTORY",
    "name": "My Instance"
}

Example HTTP response

Response 201

{
    "instance": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "region": "kr-west1",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

5 - CreatePermissionSet

5.1 - 1.4

post /v1/permission-sets

Description

create a permission set

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PermissionSetCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
201	Created	PermissionSetDetailsV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/permission-sets

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"

Request body

{
    "custom_policies": [],
    "description": "My Instance Description",
    "inline_policies": [],
    "instance_id": "ssoins-12345",
    "managed_policies": [],
    "name": "My Instance",
    "session_duration": 3600
}

Example HTTP response

Response 201

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

5.2 - 1.3

post /v1/permission-sets

Description

create a permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
body	body required		PermissionSetCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
201	Created	PermissionSetDetailsV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/permission-sets

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"

Request body

{
    "custom_policies": [],
    "description": "My Instance Description",
    "inline_policies": [],
    "instance_id": "ssoins-12345",
    "managed_policies": [],
    "name": "My Instance",
    "session_duration": 3600
}

Example HTTP response

Response 201

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

5.3 - 1.2

post /v1/permission-sets

Description

create a permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
body	body required		PermissionSetCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
201	Created	PermissionSetDetailsV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/permission-sets

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"

Request body

{
    "custom_policies": [],
    "description": "My Instance Description",
    "inline_policies": [],
    "instance_id": "ssoins-12345",
    "managed_policies": [],
    "name": "My Instance",
    "session_duration": 3600
}

Example HTTP response

Response 201

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

5.4 - 1.1

post /v1/permission-sets

Description

create a permission set

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
body	body required		PermissionSetCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PermissionSetDetails
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/permission-sets

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"

Request body

{
    "customer_policies": [],
    "description": "My Instance Description",
    "inline_policies": [],
    "instance_id": "ssoins-12345",
    "managed_policies": [],
    "name": "My Instance",
    "session_duration": 3600
}

Example HTTP response

Response 201

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "customer_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

5.5 - 1.0

post /v1/permission-sets

Description

create a permission set

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
body	body required		PermissionSetCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PermissionSetDetails
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/permission-sets

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"

Request body

{
    "customer_policies": [],
    "description": "My Instance Description",
    "inline_policies": [],
    "instance_id": "ssoins-12345",
    "managed_policies": [],
    "name": "My Instance",
    "session_duration": 3600
}

Example HTTP response

Response 201

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "customer_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

6 - CreateUser

6.1 - 1.4

post /v1/users

Description

create a user

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		UserCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	UserResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users

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"

Request body

{
    "business_unit": "Business Unit A",
    "department": "Department X",
    "description": "Description of John Doe",
    "email": "john.doe@example.com",
    "employee_id": "emp-12345",
    "group_ids": [
        "39520424-440c-41c0-9b9c-f22b2129f6f9",
        "80c53fe1-4e27-4cce-92be-151cf0f2873e"
    ],
    "instance_id": "ssoins-12345",
    "manager": "Alice Smith",
    "name": "John Doe",
    "nation_id": "+82",
    "password": "",
    "phone_number": "010-1234-5678",
    "temporary_password": true,
    "user_id": "johndoe"
}

Example HTTP response

Response 201

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

6.2 - 1.3

post /v1/users

Description

create a user

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
body	body required		UserCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	UserResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users

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"

Request body

{
    "business_unit": "Business Unit A",
    "department": "Department X",
    "description": "Description of John Doe",
    "email": "john.doe@example.com",
    "employee_id": "emp-12345",
    "group_ids": [
        "39520424-440c-41c0-9b9c-f22b2129f6f9",
        "80c53fe1-4e27-4cce-92be-151cf0f2873e"
    ],
    "instance_id": "ssoins-12345",
    "manager": "Alice Smith",
    "name": "John Doe",
    "nation_id": "+82",
    "password": "",
    "phone_number": "010-1234-5678",
    "temporary_password": true,
    "user_id": "johndoe"
}

Example HTTP response

Response 201

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

6.3 - 1.2

post /v1/users

Description

create a user

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
body	body required		UserCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	UserResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users

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"

Request body

{
    "business_unit": "Business Unit A",
    "department": "Department X",
    "description": "Description of John Doe",
    "email": "john.doe@example.com",
    "employee_id": "emp-12345",
    "group_ids": [
        "39520424-440c-41c0-9b9c-f22b2129f6f9",
        "80c53fe1-4e27-4cce-92be-151cf0f2873e"
    ],
    "instance_id": "ssoins-12345",
    "manager": "Alice Smith",
    "name": "John Doe",
    "nation_id": "+82",
    "password": "",
    "phone_number": "010-1234-5678",
    "temporary_password": true,
    "user_id": "johndoe"
}

Example HTTP response

Response 201

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

6.4 - 1.1

post /v1/users

Description

create a user

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
body	body required		UserCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	UserResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users

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"

Request body

{
    "business_unit": "Business Unit A",
    "department": "Department X",
    "description": "Description of John Doe",
    "email": "john.doe@example.com",
    "employee_id": "emp-12345",
    "group_ids": [
        "39520424-440c-41c0-9b9c-f22b2129f6f9",
        "80c53fe1-4e27-4cce-92be-151cf0f2873e"
    ],
    "instance_id": "ssoins-12345",
    "manager": "Alice Smith",
    "name": "John Doe",
    "nation_id": "+82",
    "password": "",
    "phone_number": "010-1234-5678",
    "temporary_password": true,
    "user_id": "johndoe"
}

Example HTTP response

Response 201

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

6.5 - 1.0

post /v1/users

Description

create a user

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
body	body required		UserCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	UserResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users

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"

Request body

{
    "business_unit": "Business Unit A",
    "department": "Department X",
    "description": "Description of John Doe",
    "email": "john.doe@example.com",
    "employee_id": "emp-12345",
    "group_ids": [
        "39520424-440c-41c0-9b9c-f22b2129f6f9",
        "80c53fe1-4e27-4cce-92be-151cf0f2873e"
    ],
    "instance_id": "ssoins-12345",
    "manager": "Alice Smith",
    "name": "John Doe",
    "nation_id": "+82",
    "password": "",
    "phone_number": "010-1234-5678",
    "temporary_password": true,
    "user_id": "johndoe"
}

Example HTTP response

Response 201

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

7 - DeleteAccountAssignment

7.1 - 1.4

delete /v1/account-assignments/{account_assignment_id}

Description

delete a specific account Assignment

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	account_assignment_id required	Assignment ID Example : `b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8`	string	None
body	body required		AccountAssignmentDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/account-assignments/{account_assignment_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"

Request body

{
    "instance_id": "ssoins-12345",
    "only_user_removed": false,
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 204

7.2 - 1.3

delete /v1/account-assignments/{account_assignment_id}

Description

delete a specific account Assignment

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	account_assignment_id required	Assignment ID Example : `b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8`	string	None
body	body required		AccountAssignmentDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/account-assignments/{account_assignment_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"

Request body

{
    "instance_id": "ssoins-12345",
    "only_user_removed": false,
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 204

7.3 - 1.2

delete /v1/account-assignments/{account_assignment_id}

Description

delete a specific account Assignment

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	account_assignment_id required	Assignment ID Example : `b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8`	string	None
body	body required		AccountAssignmentDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/account-assignments/{account_assignment_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"

Request body

{
    "instance_id": "ssoins-12345",
    "only_user_removed": false,
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 204

7.4 - 1.1

delete /v1/account-assignments/{account_assignment_id}

Description

delete a specific account Assignment

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
path	account_assignment_id required	Assignment ID Example : `b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8`	string	None
body	body required		AccountAssignmentDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/account-assignments/{account_assignment_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"

Request body

{
    "instance_id": "ssoins-12345",
    "only_user_removed": false,
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 204

7.5 - 1.0

delete /v1/account-assignments/{account_assignment_id}

Description

delete a specific account Assignment

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
path	account_assignment_id required	Assignment ID Example : `b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8`	string	None
body	body required		AccountAssignmentDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/account-assignments/{account_assignment_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"

Request body

{
    "instance_id": "ssoins-12345",
    "only_user_removed": false,
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 204

8 - DeleteBulkAccountAssignment

8.1 - 1.4

delete /v1/account-assignments

Description

delete multiple account Assignment

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		AccountAssignmentsDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/account-assignments

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"

Request body

{
    "account_assignment_ids": [
        "b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8"
    ],
    "instance_id": "ssoins-12345",
    "only_user_removed": false,
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 204

8.2 - 1.3

delete /v1/account-assignments

Description

delete multiple account Assignment

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
body	body required		AccountAssignmentsDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/account-assignments

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"

Request body

{
    "account_assignment_ids": [
        "b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8"
    ],
    "instance_id": "ssoins-12345",
    "only_user_removed": false,
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 204

8.3 - 1.2

delete /v1/account-assignments

Description

delete multiple account Assignment

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
body	body required		AccountAssignmentsDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/account-assignments

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"

Request body

{
    "account_assignment_ids": [
        "b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8"
    ],
    "instance_id": "ssoins-12345",
    "only_user_removed": false,
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 204

8.4 - 1.1

delete /v1/account-assignments

Description

delete multiple account Assignment

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
body	body required		AccountAssignmentsDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/account-assignments

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"

Request body

{
    "account_assignment_ids": [
        "b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8"
    ],
    "instance_id": "ssoins-12345",
    "only_user_removed": false,
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 204

8.5 - 1.0

delete /v1/account-assignments

Description

delete multiple account Assignment

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
body	body required		AccountAssignmentsDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/account-assignments

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"

Request body

{
    "account_assignment_ids": [
        "b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8"
    ],
    "instance_id": "ssoins-12345",
    "only_user_removed": false,
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 204

9 - DeleteBulkGroups

9.1 - 1.4

delete /v1/groups

Description

delete groups

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		GroupDeleteBulkRequest

Responses

HTTP Code	Description	Schema
200	OK	GroupRemoveResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	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-identity-center 1.4"

Request body

{
    "group_ids": [
        "group-12345",
        "group-67890"
    ],
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

9.2 - 1.3

delete /v1/groups

Description

delete groups

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
body	body required		GroupDeleteBulkRequest

Responses

HTTP Code	Description	Schema
200	OK	GroupRemoveResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	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-identity-center 1.3"

Request body

{
    "group_ids": [
        "group-12345",
        "group-67890"
    ],
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

9.3 - 1.2

delete /v1/groups

Description

delete groups

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
body	body required		GroupDeleteBulkRequest

Responses

HTTP Code	Description	Schema
200	OK	GroupRemoveResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	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-identity-center 1.2"

Request body

{
    "group_ids": [
        "group-12345",
        "group-67890"
    ],
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

9.4 - 1.1

delete /v1/groups

Description

delete 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
body	body required		GroupDeleteBulkRequest

Responses

HTTP Code	Description	Schema
200	OK	GroupRemoveResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	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-identity-center 1.1"

Request body

{
    "group_ids": [
        "group-12345",
        "group-67890"
    ],
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

9.5 - 1.0

delete /v1/groups

Description

delete 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
body	body required		GroupDeleteBulkRequest

Responses

HTTP Code	Description	Schema
200	OK	GroupRemoveResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	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-identity-center 1.0"

Request body

{
    "group_ids": [
        "group-12345",
        "group-67890"
    ],
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

10 - DeleteBulkGroupUsers

10.1 - 1.4

delete /v1/groups/{group_id}/users

Description

remove users from the specific group

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupUsersRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/groups/{group_id}/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 204

10.2 - 1.3

delete /v1/groups/{group_id}/users

Description

remove users from the specific group

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupUsersRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/groups/{group_id}/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 204

10.3 - 1.2

delete /v1/groups/{group_id}/users

Description

remove users from the specific group

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupUsersRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/groups/{group_id}/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 204

10.4 - 1.1

delete /v1/groups/{group_id}/users

Description

remove users from the specific group

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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupUsersRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/groups/{group_id}/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 204

10.5 - 1.0

delete /v1/groups/{group_id}/users

Description

remove users from the specific group

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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupUsersRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/groups/{group_id}/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 204

11 - DeleteBulkUsers

11.1 - 1.4

delete /v1/users

Description

delete bulk users

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		UserDeleteBulkRequest

Responses

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

Example HTTP request

Request path

/v1/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

11.2 - 1.3

delete /v1/users

Description

delete bulk users

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
body	body required		UserDeleteBulkRequest

Responses

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

Example HTTP request

Request path

/v1/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

11.3 - 1.2

delete /v1/users

Description

delete bulk users

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
body	body required		UserDeleteBulkRequest

Responses

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

Example HTTP request

Request path

/v1/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

11.4 - 1.1

delete /v1/users

Description

delete bulk users

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
body	body required		UserDeleteBulkRequest

Responses

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

Example HTTP request

Request path

/v1/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

11.5 - 1.0

delete /v1/users

Description

delete bulk users

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
body	body required		UserDeleteBulkRequest

Responses

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

Example HTTP request

Request path

/v1/users

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"

Request body

{
    "instance_id": "ssoins-12345",
    "user_uuids": [
        "user-12345",
        "user-67890"
    ]
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

12 - DeleteGroup

12.1 - 1.4

delete /v1/groups/{group_id}

Description

delete a specific group

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		InstanceBaseRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_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"

Request body

{
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

12.2 - 1.3

delete /v1/groups/{group_id}

Description

delete a specific group

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		InstanceBaseRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_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"

Request body

{
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

12.3 - 1.2

delete /v1/groups/{group_id}

Description

delete a specific group

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		InstanceBaseRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_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"

Request body

{
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

12.4 - 1.1

delete /v1/groups/{group_id}

Description

delete a specific group

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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		InstanceBaseRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_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"

Request body

{
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

12.5 - 1.0

delete /v1/groups/{group_id}

Description

delete a specific group

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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		InstanceBaseRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_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"

Request body

{
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

13 - DeleteInstance

13.1 - 1.4

delete /v1/instances/{instance_id}

Description

delete a specific instance

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/instances/{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 204

13.2 - 1.3

delete /v1/instances/{instance_id}

Description

delete a specific instance

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/instances/{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 204

13.3 - 1.2

delete /v1/instances/{instance_id}

Description

delete a specific instance

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/instances/{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 204

13.4 - 1.1

delete /v1/instances/{instance_id}

Description

delete a specific instance

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
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/instances/{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 204

13.5 - 1.0

delete /v1/instances/{instance_id}

Description

delete a specific instance

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
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/instances/{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 204

14 - DeletePermissionSet

14.1 - 1.4

delete /v1/permission-sets/{permission_set_id}

Description

delete a specific permission set

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}?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 204

14.2 - 1.3

delete /v1/permission-sets/{permission_set_id}

Description

delete a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}?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 204

14.3 - 1.2

delete /v1/permission-sets/{permission_set_id}

Description

delete a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}?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 204

14.4 - 1.1

delete /v1/permission-sets/{permission_set_id}

Description

delete a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}?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 204

14.5 - 1.0

delete /v1/permission-sets/{permission_set_id}

Description

delete a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}?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 204

15 - DeletePermissionSetPolicies

15.1 - 1.4

delete /v1/permission-sets/{permission_set_id}/policies

Description

delete policies to a specific permission set

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetPoliciesDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies

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"

Request body

{
    "instance_id": "ssoins-12345",
    "policy_ids": [
        ""
    ]
}

Example HTTP response

Response 204

15.2 - 1.3

delete /v1/permission-sets/{permission_set_id}/policies

Description

delete policies to a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetPoliciesDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies

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"

Request body

{
    "instance_id": "ssoins-12345",
    "policy_ids": [
        ""
    ]
}

Example HTTP response

Response 204

15.3 - 1.2

delete /v1/permission-sets/{permission_set_id}/policies

Description

delete policies to a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetPoliciesDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies

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"

Request body

{
    "instance_id": "ssoins-12345",
    "policy_ids": [
        ""
    ]
}

Example HTTP response

Response 204

15.4 - 1.1

delete /v1/permission-sets/{permission_set_id}/policies

Description

delete policies to a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetPoliciesDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies

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"

Request body

{
    "instance_id": "ssoins-12345",
    "policy_ids": [
        ""
    ]
}

Example HTTP response

Response 204

15.5 - 1.0

delete /v1/permission-sets/{permission_set_id}/policies

Description

delete policies to a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetPoliciesDeleteRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies

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"

Request body

{
    "instance_id": "ssoins-12345",
    "policy_ids": [
        ""
    ]
}

Example HTTP response

Response 204

16 - DeleteUser

16.1 - 1.4

delete /v1/users/{user_uuid}

Description

delete a specific user

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		InstanceBaseRequest

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}

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"

Request body

{
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

16.2 - 1.3

delete /v1/users/{user_uuid}

Description

delete a specific user

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		InstanceBaseRequest

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}

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"

Request body

{
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

16.3 - 1.2

delete /v1/users/{user_uuid}

Description

delete a specific user

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		InstanceBaseRequest

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}

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"

Request body

{
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

16.4 - 1.1

delete /v1/users/{user_uuid}

Description

delete a specific user

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
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		InstanceBaseRequest

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}

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"

Request body

{
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

16.5 - 1.0

delete /v1/users/{user_uuid}

Description

delete a specific user

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
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		InstanceBaseRequest

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}

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"

Request body

{
    "instance_id": "ssoins-12345"
}

Example HTTP response

Response 200

{
    "failed_ids": [
        {
            "error_code": "NOT_FOUND",
            "failed_caused": "NotFoundError",
            "failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "failed_name": ""
        }
    ],
    "success_ids": [
        {
            "success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
            "success_name": "test"
        }
    ]
}

17 - ListAccountAssignments

17.1 - 1.4

get /v1/account-assignments

Description

get account assignment 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	target_account_id required	Assigned Account ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
query	target_account_name optional	Assigned Account Name Example : `Admin Account`	any of [string, null]	None
query	target_account_email optional	Assigned Account Email Example : `target_account@example.com`	any of [string, null]	None
query	permission_set_id optional	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	any of [string, null]	None
query	principal_name optional	Principal Name Example : `GROUP0407`	any of [string, null]	None
query	role_srn optional	Role SRN Example : `srn:role:kr-j:1234:role/admin@example.com`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/account-assignments?instance_id={instance_id}&target_account_id={target_account_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

{
    "account_assignments": [
        {
            "instance_id": "ssoins-12345",
            "permission_sets": [],
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_name": "GROUP0407",
            "principal_type": "USER",
            "role_srn": "Permissions for administrators",
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "Admin Account"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

17.2 - 1.3

get /v1/account-assignments

Description

get account assignment 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	target_account_id required	Assigned Account ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
query	target_account_name optional	Assigned Account Name Example : `Admin Account`	any of [string, null]	None
query	target_account_email optional	Assigned Account Email Example : `target_account@example.com`	any of [string, null]	None
query	permission_set_id optional	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	any of [string, null]	None
query	principal_name optional	Principal Name Example : `GROUP0407`	any of [string, null]	None
query	role_srn optional	Role SRN Example : `srn:role:kr-j:1234:role/admin@example.com`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/account-assignments?instance_id={instance_id}&target_account_id={target_account_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

{
    "account_assignments": [
        {
            "instance_id": "ssoins-12345",
            "permission_sets": [],
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_name": "GROUP0407",
            "principal_type": "USER",
            "role_srn": "Permissions for administrators",
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "Admin Account"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

17.3 - 1.2

get /v1/account-assignments

Description

get account assignment 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	target_account_id required	Assigned Account ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
query	target_account_name optional	Assigned Account Name Example : `Admin Account`	any of [string, null]	None
query	target_account_email optional	Assigned Account Email Example : `target_account@example.com`	any of [string, null]	None
query	permission_set_id optional	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	any of [string, null]	None
query	principal_name optional	Principal Name Example : `GROUP0407`	any of [string, null]	None
query	role_srn optional	Role SRN Example : `srn:role:kr-j:1234:role/admin@example.com`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/account-assignments?instance_id={instance_id}&target_account_id={target_account_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

{
    "account_assignments": [
        {
            "instance_id": "ssoins-12345",
            "permission_sets": [],
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_name": "GROUP0407",
            "principal_type": "USER",
            "role_srn": "Permissions for administrators",
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "Admin Account"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

17.4 - 1.1

get /v1/account-assignments

Description

get account assignment 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	target_account_id required	Assigned Account ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
query	target_account_name optional	Assigned Account Name Example : `Admin Account`	any of [string, null]	None
query	target_account_email optional	Assigned Account Email Example : `target_account@example.com`	any of [string, null]	None
query	permission_set_id optional	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	any of [string, null]	None
query	principal_name optional	Principal Name Example : `GROUP0407`	any of [string, null]	None
query	role_srn optional	Role SRN Example : `srn:role:kr-j:1234:role/admin@example.com`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/account-assignments?instance_id={instance_id}&target_account_id={target_account_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

{
    "account_assignments": [
        {
            "instance_id": "ssoins-12345",
            "permission_sets": [],
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_name": "GROUP0407",
            "principal_type": "USER",
            "role_srn": "Permissions for administrators",
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "Admin Account"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

17.5 - 1.0

get /v1/account-assignments

Description

get account assignment 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	target_account_id required	Assigned Account ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
query	target_account_name optional	Assigned Account Name Example : `Admin Account`	any of [string, null]	None
query	target_account_email optional	Assigned Account Email Example : `target_account@example.com`	any of [string, null]	None
query	permission_set_id optional	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	any of [string, null]	None
query	principal_name optional	Principal Name Example : `GROUP0407`	any of [string, null]	None
query	role_srn optional	Role SRN Example : `srn:role:kr-j:1234:role/admin@example.com`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/account-assignments?instance_id={instance_id}&target_account_id={target_account_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

{
    "account_assignments": [
        {
            "instance_id": "ssoins-12345",
            "permission_sets": [],
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_name": "GROUP0407",
            "principal_type": "USER",
            "role_srn": "Permissions for administrators",
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "Admin Account"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

18 - ListGroups

18.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"
    ]
}

18.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"
    ]
}

18.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"
    ]
}

18.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"
    ]
}

18.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"
    ]
}

19 - ListGroupUsers

19.1 - 1.4

get /v1/groups/{group_id}/users

Description

get group users list

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
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	user_id optional	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}/users?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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "group_count": 2,
            "groups": [
                {
                    "created_at": "2025-07-03T12:05:11",
                    "created_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "id": "39520424-440c-41c0-9b9c-f22b2129f6f9",
                    "modified_at": "2025-07-03T12:05:11",
                    "modified_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "name": "admin"
                },
                {
                    "created_at": "2025-07-03T12:05:36",
                    "created_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "id": "80c53fe1-4e27-4cce-92be-151cf0f2873e",
                    "modified_at": "2025-07-07T05:16:58",
                    "modified_by": "941e76c4b9424cd9b0ac3a12d5f4335d",
                    "name": "test-group"
                }
            ],
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "John Doe",
            "user_id": "johndoe"
        }
    ]
}

19.2 - 1.3

get /v1/groups/{group_id}/users

Description

get group users list

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
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	user_id optional	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}/users?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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "group_count": 2,
            "groups": [
                {
                    "created_at": "2025-07-03T12:05:11",
                    "created_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "id": "39520424-440c-41c0-9b9c-f22b2129f6f9",
                    "modified_at": "2025-07-03T12:05:11",
                    "modified_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "name": "admin"
                },
                {
                    "created_at": "2025-07-03T12:05:36",
                    "created_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "id": "80c53fe1-4e27-4cce-92be-151cf0f2873e",
                    "modified_at": "2025-07-07T05:16:58",
                    "modified_by": "941e76c4b9424cd9b0ac3a12d5f4335d",
                    "name": "test-group"
                }
            ],
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "John Doe",
            "user_id": "johndoe"
        }
    ]
}

19.3 - 1.2

get /v1/groups/{group_id}/users

Description

get group users list

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
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	user_id optional	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}/users?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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "group_count": 2,
            "groups": [
                {
                    "created_at": "2025-07-03T12:05:11",
                    "created_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "id": "39520424-440c-41c0-9b9c-f22b2129f6f9",
                    "modified_at": "2025-07-03T12:05:11",
                    "modified_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "name": "admin"
                },
                {
                    "created_at": "2025-07-03T12:05:36",
                    "created_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "id": "80c53fe1-4e27-4cce-92be-151cf0f2873e",
                    "modified_at": "2025-07-07T05:16:58",
                    "modified_by": "941e76c4b9424cd9b0ac3a12d5f4335d",
                    "name": "test-group"
                }
            ],
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "John Doe",
            "user_id": "johndoe"
        }
    ]
}

19.4 - 1.1

get /v1/groups/{group_id}/users

Description

get group users 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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
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	user_id optional	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}/users?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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "group_count": 2,
            "groups": [
                {
                    "created_at": "2025-07-03T12:05:11",
                    "created_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "id": "39520424-440c-41c0-9b9c-f22b2129f6f9",
                    "modified_at": "2025-07-03T12:05:11",
                    "modified_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "name": "admin"
                },
                {
                    "created_at": "2025-07-03T12:05:36",
                    "created_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "id": "80c53fe1-4e27-4cce-92be-151cf0f2873e",
                    "modified_at": "2025-07-07T05:16:58",
                    "modified_by": "941e76c4b9424cd9b0ac3a12d5f4335d",
                    "name": "test-group"
                }
            ],
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "John Doe",
            "user_id": "johndoe"
        }
    ]
}

19.5 - 1.0

get /v1/groups/{group_id}/users

Description

get group users 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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
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	user_id optional	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}/users?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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "group_count": 2,
            "groups": [
                {
                    "created_at": "2025-07-03T12:05:11",
                    "created_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "id": "39520424-440c-41c0-9b9c-f22b2129f6f9",
                    "modified_at": "2025-07-03T12:05:11",
                    "modified_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "name": "admin"
                },
                {
                    "created_at": "2025-07-03T12:05:36",
                    "created_by": "a8b5d675f25341cea41eb4cd1979aa95",
                    "id": "80c53fe1-4e27-4cce-92be-151cf0f2873e",
                    "modified_at": "2025-07-07T05:16:58",
                    "modified_by": "941e76c4b9424cd9b0ac3a12d5f4335d",
                    "name": "test-group"
                }
            ],
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "John Doe",
            "user_id": "johndoe"
        }
    ]
}

20 - ListInstances

20.1 - 1.4

get /v1/instances

Description

get instances 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

Responses

HTTP Code	Description	Schema
200	OK	InstancePageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/instances

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,
    "instances": [],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

20.2 - 1.3

get /v1/instances

Description

get instances 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

Responses

HTTP Code	Description	Schema
200	OK	InstancePageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/instances

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,
    "instances": [],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

20.3 - 1.2

get /v1/instances

Description

get instances 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

Responses

HTTP Code	Description	Schema
200	OK	InstancePageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/instances

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,
    "instances": [],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

20.4 - 1.1

get /v1/instances

Description

get instances 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	name optional	Instance Name Example : `My Instance`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	InstancePageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/instances

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,
    "instances": [],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

20.5 - 1.0

get /v1/instances

Description

get instances 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	name optional	Instance Name Example : `My Instance`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	InstancePageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/instances

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,
    "instances": [],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

21 - ListPermissionSetPolicies

21.1 - 1.4

get /v1/permission-sets/{permission_set_id}/policies

Description

get policies to a specific permission set

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
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	category optional	Policy Type Example : `INLINE_POLICY`	any of [enum (MANAGED_POLICY, CUSTOM_POLICY, INLINE_POLICY), null]	None
query	name optional	None Example : `Permission Set`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies?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,
    "page": 0,
    "policies": [],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

21.2 - 1.3

get /v1/permission-sets/{permission_set_id}/policies

Description

get policies to a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
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	category optional	Policy Type Example : `INLINE_POLICY`	any of [enum (MANAGED_POLICY, CUSTOM_POLICY, INLINE_POLICY), null]	None
query	name optional	None Example : `Permission Set`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies?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,
    "page": 0,
    "policies": [],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

21.3 - 1.2

get /v1/permission-sets/{permission_set_id}/policies

Description

get policies to a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
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	category optional	Policy Type Example : `INLINE_POLICY`	any of [enum (MANAGED_POLICY, CUSTOM_POLICY, INLINE_POLICY), null]	None
query	name optional	None Example : `Permission Set`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies?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,
    "page": 0,
    "policies": [],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

21.4 - 1.1

get /v1/permission-sets/{permission_set_id}/policies

Description

get policies to a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
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	category optional	Policy Type Example : `INLINE_POLICY`	any of [enum (MANAGED_POLICY, CUSTOMER_POLICY, INLINE_POLICY), null]	None
query	name optional	None Example : `Permission Set`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies?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,
    "page": 0,
    "policies": [],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

21.5 - 1.0

get /v1/permission-sets/{permission_set_id}/policies

Description

get policies to a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
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	category optional	Policy Type Example : `INLINE_POLICY`	any of [enum (MANAGED_POLICY, CUSTOMER_POLICY, INLINE_POLICY), null]	None
query	name optional	None Example : `Permission Set`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies?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,
    "page": 0,
    "policies": [],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

22 - ListPermissionSets

22.1 - 1.4

get /v1/permission-sets

Description

get permission sets 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	Permission Set Name Example : `Permission Set`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets?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,
    "page": 0,
    "permission_sets": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "creator_name": "",
            "custom_policies": [
                ""
            ],
            "description": "Permissions for administrators",
            "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "inline_policies": [
                ""
            ],
            "instance_id": "ssoins-12345",
            "managed_policies": [
                ""
            ],
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modifier_name": "",
            "name": "Permission Set",
            "session_duration": 3600,
            "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

22.2 - 1.3

get /v1/permission-sets

Description

get permission sets 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	Permission Set Name Example : `Permission Set`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets?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,
    "page": 0,
    "permission_sets": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "creator_name": "",
            "custom_policies": [
                ""
            ],
            "description": "Permissions for administrators",
            "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "inline_policies": [
                ""
            ],
            "instance_id": "ssoins-12345",
            "managed_policies": [
                ""
            ],
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modifier_name": "",
            "name": "Permission Set",
            "session_duration": 3600,
            "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

22.3 - 1.2

get /v1/permission-sets

Description

get permission sets 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	Permission Set Name Example : `Permission Set`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets?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,
    "page": 0,
    "permission_sets": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "creator_name": "",
            "custom_policies": [
                ""
            ],
            "description": "Permissions for administrators",
            "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "inline_policies": [
                ""
            ],
            "instance_id": "ssoins-12345",
            "managed_policies": [
                ""
            ],
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modifier_name": "",
            "name": "Permission Set",
            "session_duration": 3600,
            "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

22.4 - 1.1

get /v1/permission-sets

Description

get permission sets 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	Permission Set Name Example : `Permission Set`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets?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,
    "page": 0,
    "permission_sets": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "creator_name": "",
            "description": "Permissions for administrators",
            "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "instance_id": "ssoins-12345",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modifier_name": "",
            "name": "Permission Set",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

22.5 - 1.0

get /v1/permission-sets

Description

get permission sets 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	Permission Set Name Example : `Permission Set`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets?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,
    "page": 0,
    "permission_sets": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "creator_name": "",
            "description": "Permissions for administrators",
            "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "instance_id": "ssoins-12345",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modifier_name": "",
            "name": "Permission Set",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

23 - ListUsers

23.1 - 1.4

get /v1/users

Description

get users 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	user_id optional	User Login ID Example : `johndoe`	any of [string, null]	None
query	excluded_group_id optional	Group 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	UserPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users?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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "name": "John Doe",
            "user_id": "johndoe"
        }
    ]
}

23.2 - 1.3

get /v1/users

Description

get users 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	user_id optional	User Login ID Example : `johndoe`	any of [string, null]	None
query	excluded_group_id optional	Group 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	UserPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users?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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "name": "John Doe",
            "user_id": "johndoe"
        }
    ]
}

23.3 - 1.2

get /v1/users

Description

get users 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	user_id optional	User Login ID Example : `johndoe`	any of [string, null]	None
query	excluded_group_id optional	Group 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	UserPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users?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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "name": "John Doe",
            "user_id": "johndoe"
        }
    ]
}

23.4 - 1.1

get /v1/users

Description

get users 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	user_id optional	User Login ID Example : `johndoe`	any of [string, null]	None
query	excluded_group_id optional	Group 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	UserPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users?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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "name": "John Doe",
            "user_id": "johndoe"
        }
    ]
}

23.5 - 1.0

get /v1/users

Description

get users 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	user_id optional	User Login ID Example : `johndoe`	any of [string, null]	None
query	excluded_group_id optional	Group 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	UserPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/users?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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "users": [
        {
            "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "name": "John Doe",
            "user_id": "johndoe"
        }
    ]
}

24 - SetGroup

24.1 - 1.4

patch /v1/groups/{group_id}

Description

set a specific group

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupSetRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_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"

Request body

{
    "description": "Group for administrators",
    "instance_id": "ssoins-12345",
    "name": "Admin_Group"
}

Example HTTP response

Response 200

{
    "group": {
        "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"
    }
}

24.2 - 1.3

patch /v1/groups/{group_id}

Description

set a specific group

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupSetRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_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"

Request body

{
    "description": "Group for administrators",
    "instance_id": "ssoins-12345",
    "name": "Admin_Group"
}

Example HTTP response

Response 200

{
    "group": {
        "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"
    }
}

24.3 - 1.2

patch /v1/groups/{group_id}

Description

set a specific group

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupSetRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_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"

Request body

{
    "description": "Group for administrators",
    "instance_id": "ssoins-12345",
    "name": "Admin_Group"
}

Example HTTP response

Response 200

{
    "group": {
        "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"
    }
}

24.4 - 1.1

patch /v1/groups/{group_id}

Description

set a specific group

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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupSetRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_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"

Request body

{
    "description": "Group for administrators",
    "instance_id": "ssoins-12345",
    "name": "Admin_Group"
}

Example HTTP response

Response 200

{
    "group": {
        "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"
    }
}

24.5 - 1.0

patch /v1/groups/{group_id}

Description

set a specific group

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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		GroupSetRequest

Responses

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

Example HTTP request

Request path

/v1/groups/{group_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"

Request body

{
    "description": "Group for administrators",
    "instance_id": "ssoins-12345",
    "name": "Admin_Group"
}

Example HTTP response

Response 200

{
    "group": {
        "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"
    }
}

25 - SetInstance

25.1 - 1.4

patch /v1/instances/{instance_id}

Description

set a specific instance

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None
body	body required		InstanceSetRequest1Dot1

Responses

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

Example HTTP request

Request path

/v1/instances/{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"

Request body

{
    "description": "My Instance Description",
    "identity_store_config": {
        "bind_credential": "password",
        "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
        "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
        "connection_url": "ldaps://test.subdomain.company.com:123",
        "rdn_ldap_attribute": "cn",
        "user_object_classes": "person, organizationalPerson, user",
        "username_ldap_attribute": "sAMAccountName",
        "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
    },
    "identity_store_type": "IDENTITY_CENTER_DIRECTORY",
    "name": "My Instance"
}

Example HTTP response

Response 200

{
    "instance": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "region": "kr-west1",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

25.2 - 1.3

patch /v1/instances/{instance_id}

Description

set a specific instance

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None
body	body required		InstanceSetRequest1Dot1

Responses

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

Example HTTP request

Request path

/v1/instances/{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"

Request body

{
    "description": "My Instance Description",
    "identity_store_config": {
        "bind_credential": "password",
        "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
        "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
        "connection_url": "ldaps://test.subdomain.company.com:123",
        "rdn_ldap_attribute": "cn",
        "user_object_classes": "person, organizationalPerson, user",
        "username_ldap_attribute": "sAMAccountName",
        "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
    },
    "identity_store_type": "IDENTITY_CENTER_DIRECTORY",
    "name": "My Instance"
}

Example HTTP response

Response 200

{
    "instance": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "region": "kr-west1",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

25.3 - 1.2

patch /v1/instances/{instance_id}

Description

set a specific instance

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None
body	body required		InstanceSetRequest1Dot1

Responses

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

Example HTTP request

Request path

/v1/instances/{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"

Request body

{
    "description": "My Instance Description",
    "identity_store_config": {
        "bind_credential": "password",
        "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
        "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
        "connection_url": "ldaps://test.subdomain.company.com:123",
        "rdn_ldap_attribute": "cn",
        "user_object_classes": "person, organizationalPerson, user",
        "username_ldap_attribute": "sAMAccountName",
        "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
    },
    "identity_store_type": "IDENTITY_CENTER_DIRECTORY",
    "name": "My Instance"
}

Example HTTP response

Response 200

{
    "instance": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "region": "kr-west1",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

25.4 - 1.1

patch /v1/instances/{instance_id}

Description

set a specific instance

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
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None
body	body required		InstanceSetRequest1Dot1

Responses

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

Example HTTP request

Request path

/v1/instances/{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"

Request body

{
    "description": "My Instance Description",
    "identity_store_config": {
        "bind_credential": "password",
        "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
        "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
        "connection_url": "ldaps://test.subdomain.company.com:123",
        "rdn_ldap_attribute": "cn",
        "user_object_classes": "person, organizationalPerson, user",
        "username_ldap_attribute": "sAMAccountName",
        "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
    },
    "identity_store_type": "IDENTITY_CENTER_DIRECTORY",
    "name": "My Instance"
}

Example HTTP response

Response 200

{
    "instance": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "region": "kr-west1",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

26 - SetPermissionSet

26.1 - 1.4

patch /v1/permission-sets/{permission_set_id}

Description

set a specific permission set

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetSetRequest

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_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"

Request body

{
    "description": "My Instance Description",
    "instance_id": "ssoins-12345",
    "session_duration": 3600
}

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

26.2 - 1.3

patch /v1/permission-sets/{permission_set_id}

Description

set a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetSetRequest

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_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"

Request body

{
    "description": "My Instance Description",
    "instance_id": "ssoins-12345",
    "session_duration": 3600
}

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

26.3 - 1.2

patch /v1/permission-sets/{permission_set_id}

Description

set a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetSetRequest

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_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"

Request body

{
    "description": "My Instance Description",
    "instance_id": "ssoins-12345",
    "session_duration": 3600
}

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

26.4 - 1.1

patch /v1/permission-sets/{permission_set_id}

Description

set a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetSetRequest

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_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"

Request body

{
    "description": "My Instance Description",
    "instance_id": "ssoins-12345",
    "session_duration": 3600
}

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "customer_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

26.5 - 1.0

patch /v1/permission-sets/{permission_set_id}

Description

set a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetSetRequest

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_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"

Request body

{
    "description": "My Instance Description",
    "instance_id": "ssoins-12345",
    "session_duration": 3600
}

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "customer_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

27 - SetPermissionSetPolicies

27.1 - 1.4

put /v1/permission-sets/{permission_set_id}/policies

Description

set policies to a specific permission set

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetPoliciesSetRequestV1Dot2

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies

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"

Request body

{
    "custom_policies": [
        ""
    ],
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

27.2 - 1.3

put /v1/permission-sets/{permission_set_id}/policies

Description

set policies to a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetPoliciesSetRequestV1Dot2

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies

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"

Request body

{
    "custom_policies": [
        ""
    ],
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

27.3 - 1.2

put /v1/permission-sets/{permission_set_id}/policies

Description

set policies to a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetPoliciesSetRequestV1Dot2

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies

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"

Request body

{
    "custom_policies": [
        ""
    ],
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

27.4 - 1.1

put /v1/permission-sets/{permission_set_id}/policies

Description

set policies to a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetPoliciesSetRequest

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies

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"

Request body

{
    "customer_policies": [
        ""
    ],
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "customer_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

27.5 - 1.0

put /v1/permission-sets/{permission_set_id}/policies

Description

set policies to a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
body	body required		PermissionSetPoliciesSetRequest

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies

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"

Request body

{
    "customer_policies": [
        ""
    ],
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "customer_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

28 - SetUser

28.1 - 1.4

patch /v1/users/{user_uuid}

Description

set a specific user

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		UserSetRequest

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}

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"

Request body

{
    "business_unit": "Business Unit A",
    "department": "Department X",
    "description": "Description of John Doe",
    "email": "john.doe@example.com",
    "employee_id": "emp-12345",
    "instance_id": "ssoins-12345",
    "manager": "Alice Smith",
    "name": "John Doe",
    "nation_id": "+82",
    "phone_number": "010-1234-5678",
    "tz_id": "Asia/Seoul"
}

Example HTTP response

Response 200

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

28.2 - 1.3

patch /v1/users/{user_uuid}

Description

set a specific user

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		UserSetRequest

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}

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"

Request body

{
    "business_unit": "Business Unit A",
    "department": "Department X",
    "description": "Description of John Doe",
    "email": "john.doe@example.com",
    "employee_id": "emp-12345",
    "instance_id": "ssoins-12345",
    "manager": "Alice Smith",
    "name": "John Doe",
    "nation_id": "+82",
    "phone_number": "010-1234-5678",
    "tz_id": "Asia/Seoul"
}

Example HTTP response

Response 200

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

28.3 - 1.2

patch /v1/users/{user_uuid}

Description

set a specific user

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		UserSetRequest

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}

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"

Request body

{
    "business_unit": "Business Unit A",
    "department": "Department X",
    "description": "Description of John Doe",
    "email": "john.doe@example.com",
    "employee_id": "emp-12345",
    "instance_id": "ssoins-12345",
    "manager": "Alice Smith",
    "name": "John Doe",
    "nation_id": "+82",
    "phone_number": "010-1234-5678",
    "tz_id": "Asia/Seoul"
}

Example HTTP response

Response 200

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

28.4 - 1.1

patch /v1/users/{user_uuid}

Description

set a specific user

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
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		UserSetRequest

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}

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"

Request body

{
    "business_unit": "Business Unit A",
    "department": "Department X",
    "description": "Description of John Doe",
    "email": "john.doe@example.com",
    "employee_id": "emp-12345",
    "instance_id": "ssoins-12345",
    "manager": "Alice Smith",
    "name": "John Doe",
    "nation_id": "+82",
    "phone_number": "010-1234-5678",
    "tz_id": "Asia/Seoul"
}

Example HTTP response

Response 200

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

28.5 - 1.0

patch /v1/users/{user_uuid}

Description

set a specific user

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
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		UserSetRequest

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}

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"

Request body

{
    "business_unit": "Business Unit A",
    "department": "Department X",
    "description": "Description of John Doe",
    "email": "john.doe@example.com",
    "employee_id": "emp-12345",
    "instance_id": "ssoins-12345",
    "manager": "Alice Smith",
    "name": "John Doe",
    "nation_id": "+82",
    "phone_number": "010-1234-5678",
    "tz_id": "Asia/Seoul"
}

Example HTTP response

Response 200

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

29 - ShowGroup

29.1 - 1.4

get /v1/groups/{group_id}

Description

show a specific group

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}?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

{
    "group": {
        "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"
            }
        ]
    }
}

29.2 - 1.3

get /v1/groups/{group_id}

Description

show a specific group

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}?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

{
    "group": {
        "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"
            }
        ]
    }
}

29.3 - 1.2

get /v1/groups/{group_id}

Description

show a specific group

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}?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

{
    "group": {
        "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"
            }
        ]
    }
}

29.4 - 1.1

get /v1/groups/{group_id}

Description

show a specific group

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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}?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

{
    "group": {
        "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"
            }
        ]
    }
}

29.5 - 1.0

get /v1/groups/{group_id}

Description

show a specific group

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
path	group_id required	Group ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/groups/{group_id}?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

{
    "group": {
        "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"
            }
        ]
    }
}

30 - ShowInstance

30.1 - 1.4

get /v1/instances/{instance_id}

Description

show a specific instance

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/instances/{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

{
    "instance": {
        "account_id": "1234ab567cd64769e8f9g490hi304891",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "port": 443,
        "public_ip": "",
        "region": "kr-west1",
        "resource_name": "resource-name-1",
        "resource_type": "virtual-server",
        "resource_type_display_name": "Virtual Server",
        "service": "virtualserver",
        "service_name": "Virtual Server",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

30.2 - 1.3

get /v1/instances/{instance_id}

Description

show a specific instance

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/instances/{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

{
    "instance": {
        "account_id": "1234ab567cd64769e8f9g490hi304891",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "port": 443,
        "public_ip": "",
        "region": "kr-west1",
        "resource_name": "resource-name-1",
        "resource_type": "virtual-server",
        "resource_type_display_name": "Virtual Server",
        "service": "virtualserver",
        "service_name": "Virtual Server",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

30.3 - 1.2

get /v1/instances/{instance_id}

Description

show a specific instance

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/instances/{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

{
    "instance": {
        "account_id": "1234ab567cd64769e8f9g490hi304891",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "region": "kr-west1",
        "resource_name": "resource-name-1",
        "resource_type": "virtual-server",
        "resource_type_display_name": "Virtual Server",
        "service": "virtualserver",
        "service_name": "Virtual Server",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

30.4 - 1.1

get /v1/instances/{instance_id}

Description

show a specific instance

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
path	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/instances/{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

{
    "instance": {
        "account_id": "1234ab567cd64769e8f9g490hi304891",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "delegated_account_id": "acc-2353",
        "delegated_at": "2023-10-15 14:30:00",
        "delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
        "description": "My Instance Description",
        "id": "ssoins-12345",
        "identity_store_config": {
            "bind_credential": "password",
            "bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
            "component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
            "connection_url": "ldaps://test.subdomain.company.com:123",
            "rdn_ldap_attribute": "cn",
            "user_object_classes": "person, organizationalPerson, user",
            "username_ldap_attribute": "sAMAccountName",
            "users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
        },
        "identity_store_id": "d-12345",
        "identity_store_type": "ACTIVE_DIRECTORY",
        "last_sync_at": "2025-08-06 10:30:00",
        "last_sync_status": [
            "CREATED",
            "RUNNING",
            "FINISHED",
            "FAILED",
            "NONE",
            "ABORTED"
        ],
        "master_account_id": "acc-12345",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "My Instance",
        "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
        "region": "kr-west1",
        "resource_name": "resource-name-1",
        "resource_type": "virtual-server",
        "resource_type_display_name": "Virtual Server",
        "service": "virtualserver",
        "service_name": "Virtual Server",
        "srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
        "sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
        "state": "ACTIVE"
    }
}

31 - ShowPermissionSet

31.1 - 1.4

get /v1/permission-sets/{permission_set_id}

Description

show a specific permission set

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}?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

{
    "account_id": "",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "resource_name": "",
    "resource_type": "",
    "resource_type_display_name": "",
    "service": "",
    "service_name": "",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

31.2 - 1.3

get /v1/permission-sets/{permission_set_id}

Description

show a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}?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

{
    "account_id": "",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "resource_name": "",
    "resource_type": "",
    "resource_type_display_name": "",
    "service": "",
    "service_name": "",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

31.3 - 1.2

get /v1/permission-sets/{permission_set_id}

Description

show a specific permission set

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}?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

{
    "account_id": "",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "custom_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "resource_name": "",
    "resource_type": "",
    "resource_type_display_name": "",
    "service": "",
    "service_name": "",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

31.4 - 1.1

get /v1/permission-sets/{permission_set_id}

Description

show a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}?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

{
    "account_id": "",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "customer_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "resource_name": "",
    "resource_type": "",
    "resource_type_display_name": "",
    "service": "",
    "service_name": "",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

31.5 - 1.0

get /v1/permission-sets/{permission_set_id}

Description

show a specific permission set

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
path	permission_set_id required	Permission Set ID Example : `e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}?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

{
    "account_id": "",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "creator_name": "",
    "customer_policies": [
        ""
    ],
    "description": "Permissions for administrators",
    "id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "inline_policies": [
        ""
    ],
    "instance_id": "ssoins-12345",
    "managed_policies": [
        ""
    ],
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "modifier_name": "",
    "name": "Permission Set",
    "resource_name": "",
    "resource_type": "",
    "resource_type_display_name": "",
    "service": "",
    "service_name": "",
    "session_duration": 3600,
    "srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
    "state": "ACTIVE"
}

32 - ShowUser

32.1 - 1.4

get /v1/users/{user_uuid}

Description

show a specific user

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}?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

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

32.2 - 1.3

get /v1/users/{user_uuid}

Description

show a specific user

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261130

Parameters

Type	Name	Description	Schema	Default
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}?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

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

32.3 - 1.2

get /v1/users/{user_uuid}

Description

show a specific user

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260930

Parameters

Type	Name	Description	Schema	Default
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}?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

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

32.4 - 1.1

get /v1/users/{user_uuid}

Description

show a specific user

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
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}?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

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}

32.5 - 1.0

get /v1/users/{user_uuid}

Description

show a specific user

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
path	user_uuid required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	instance_id required	Instance ID Example : `ssoins-12345`	string	None

Responses

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

Example HTTP request

Request path

/v1/users/{user_uuid}?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

{
    "user": {
        "business_unit": "Business Unit A",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "creator_name": "John Doe",
        "department": "Department X",
        "description": "Description of John Doe",
        "email": "john.doe@example.com",
        "email_authenticated": false,
        "employee_id": "emp-12345",
        "groups": [],
        "id": "138c2fc8c29a449dbfa8681f8f1d78e2",
        "instance_id": "ssoins-12345",
        "last_login_at": "2024-12-19 01:09:05.000",
        "last_password_update_at": "2026-05-07T03:07:32.372546",
        "manager": "Alice Smith",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "modifier_name": "Smith",
        "name": "John Doe",
        "nation_id": "+82",
        "password": "",
        "password_failed_count": 6,
        "password_reuse_count": 6,
        "phone_authenticated": false,
        "phone_number": "010-1234-5678",
        "temporary_password": "",
        "tz_id": "Asia/Seoul",
        "user_id": "johndoe"
    }
}