ID Center
Overview
ID Center is a service that allows you to easily manage access permissions to Samsung Cloud Platform resources from a centralized location by integrating with your organization’s identity providers.
This guide provides a brief description of IAM service and how to call API.
The API is provided as a RESTful API, and it responds in JSON format.
Version
| Version | Status | Supported Until |
|---|
| 1.0 | DEPRECATED | 20260223 |
| 1.1 | SUPPORTED | 20260531 |
| 1.2 | CURRENT | - |
OpenAPI URL
https://iam-identity-center.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
1 - APIs
1.1 - CreateAccountAssignment
1.1.1 - 1.2
post /v1/account-assignments
Description
set a specific account Assignment
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
Responses
Example HTTP request
Request path
/v1/account-assignments
"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.1.2 - 1.1
post /v1/account-assignments
Description
set a specific account Assignment
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.1 | 20260531 |
Parameters
Responses
Example HTTP request
Request path
/v1/account-assignments
"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.1.3 - 1.0
post /v1/account-assignments
Description
set a specific account Assignment
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20260223 |
Parameters
Responses
Example HTTP request
Request path
/v1/account-assignments
"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"
}
1.2 - CreateBulkGroupUsers
1.2.1 - 1.2
post /v1/groups/{group_id}/users
Description
add multiple users to a specific group
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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
"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"
}
]
}
}
1.2.2 - 1.1
post /v1/groups/{group_id}/users
Description
add multiple users to a specific group
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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
"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"
}
]
}
}
1.2.3 - 1.0
post /v1/groups/{group_id}/users
Description
add multiple users to a specific group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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
"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"
}
]
}
}
1.3 - CreateGroup
1.3.1 - 1.2
post /v1/groups
Description
create a group
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
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
"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"
}
]
}
}
1.3.2 - 1.1
post /v1/groups
Description
create a group
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.1 | 20260531 |
Parameters
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
"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"
}
]
}
}
1.3.3 - 1.0
post /v1/groups
Description
create a group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20260223 |
Parameters
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
"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"
}
]
}
}
1.4 - CreateInstance
1.4.1 - 1.2
post /v1/instances
Description
create a instance
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
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
"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"
],
"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"
}
}
1.4.2 - 1.1
post /v1/instances
Description
create a instance
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.1 | 20260531 |
Parameters
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
"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"
],
"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"
}
}
1.5 - CreatePermissionSet
1.5.1 - 1.2
post /v1/permission-sets
Description
create a permission set
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
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
"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"
}
1.5.2 - 1.1
post /v1/permission-sets
Description
create a permission set
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.1 | 20260531 |
Parameters
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
"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"
}
1.5.3 - 1.0
post /v1/permission-sets
Description
create a permission set
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20260223 |
Parameters
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
"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"
}
1.6 - CreateUser
1.6.1 - 1.2
post /v1/users
Description
create a user
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
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
"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": "2025-11-24T08:14:51.694996",
"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"
}
}
1.6.2 - 1.1
post /v1/users
Description
create a user
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.1 | 20260531 |
Parameters
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
"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": "2025-11-24T08:14:51.694996",
"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"
}
}
1.6.3 - 1.0
post /v1/users
Description
create a user
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20260223 |
Parameters
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
"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": "2025-11-24T08:14:51.694996",
"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"
}
}
1.7 - DeleteAccountAssignment
1.7.1 - 1.2
delete /v1/account-assignments/{account_assignment_id}
Description
delete a specific account Assignment
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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
1.7.2 - 1.1
delete /v1/account-assignments/{account_assignment_id}
Description
delete a specific account Assignment
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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
1.7.3 - 1.0
delete /v1/account-assignments/{account_assignment_id}
Description
delete a specific account Assignment
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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
1.8 - DeleteBulkAccountAssignment
1.8.1 - 1.2
delete /v1/account-assignments
Description
delete multiple account Assignment
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/account-assignments
"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
1.8.2 - 1.1
delete /v1/account-assignments
Description
delete multiple account Assignment
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.1 | 20260531 |
Parameters
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/account-assignments
"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
1.8.3 - 1.0
delete /v1/account-assignments
Description
delete multiple account Assignment
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20260223 |
Parameters
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/account-assignments
"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
1.9 - DeleteBulkGroups
1.9.1 - 1.2
delete /v1/groups
Description
delete groups
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
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
"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"
}
]
}
1.9.2 - 1.1
delete /v1/groups
Description
delete groups
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.1 | 20260531 |
Parameters
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
"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"
}
]
}
1.9.3 - 1.0
delete /v1/groups
Description
delete groups
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20260223 |
Parameters
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
"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"
}
]
}
1.10 - DeleteBulkGroupUsers
1.10.1 - 1.2
delete /v1/groups/{group_id}/users
Description
remove users from the specific group
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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
"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
1.10.2 - 1.1
delete /v1/groups/{group_id}/users
Description
remove users from the specific group
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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
"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
1.10.3 - 1.0
delete /v1/groups/{group_id}/users
Description
remove users from the specific group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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
"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
1.11 - DeleteBulkUsers
1.11.1 - 1.2
delete /v1/users
Description
delete bulk users
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
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
"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"
}
]
}
1.11.2 - 1.1
delete /v1/users
Description
delete bulk users
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.1 | 20260531 |
Parameters
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
"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"
}
]
}
1.11.3 - 1.0
delete /v1/users
Description
delete bulk users
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20260223 |
Parameters
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
"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"
}
]
}
1.12 - DeleteGroup
1.12.1 - 1.2
delete /v1/groups/{group_id}
Description
delete a specific group
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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"
}
]
}
1.12.2 - 1.1
delete /v1/groups/{group_id}
Description
delete a specific group
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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"
}
]
}
1.12.3 - 1.0
delete /v1/groups/{group_id}
Description
delete a specific group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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"
}
]
}
1.13 - DeleteInstance
1.13.1 - 1.2
delete /v1/instances/{instance_id}
Description
delete a specific instance
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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
1.13.2 - 1.1
delete /v1/instances/{instance_id}
Description
delete a specific instance
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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
1.13.3 - 1.0
delete /v1/instances/{instance_id}
Description
delete a specific instance
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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
1.14 - DeletePermissionSet
1.14.1 - 1.2
delete /v1/permission-sets/{permission_set_id}
Description
delete a specific permission set
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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
1.14.2 - 1.1
delete /v1/permission-sets/{permission_set_id}
Description
delete a specific permission set
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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
1.14.3 - 1.0
delete /v1/permission-sets/{permission_set_id}
Description
delete a specific permission set
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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
1.15 - DeletePermissionSetPolicies
1.15.1 - 1.2
delete /v1/permission-sets/{permission_set_id}/policies
Description
delete policies to a specific permission set
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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
"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
1.15.2 - 1.1
delete /v1/permission-sets/{permission_set_id}/policies
Description
delete policies to a specific permission set
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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
"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
1.15.3 - 1.0
delete /v1/permission-sets/{permission_set_id}/policies
Description
delete policies to a specific permission set
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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
"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
1.16 - DeleteUser
1.16.1 - 1.2
delete /v1/users/{user_uuid}
Description
delete a specific user
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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"
}
]
}
1.16.2 - 1.1
delete /v1/users/{user_uuid}
Description
delete a specific user
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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"
}
]
}
1.16.3 - 1.0
delete /v1/users/{user_uuid}
Description
delete a specific user
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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"
}
]
}
1.17 - ListAccountAssignments
1.17.1 - 1.2
get /v1/account-assignments
Description
get account assignment list
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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
Example HTTP request
Request path
/v1/account-assignments?instance_id={instance_id}&target_account_id={target_account_id}
"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"
]
}
1.17.2 - 1.1
get /v1/account-assignments
Description
get account assignment list
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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
Example HTTP request
Request path
/v1/account-assignments?instance_id={instance_id}&target_account_id={target_account_id}
"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"
]
}
1.17.3 - 1.0
get /v1/account-assignments
Description
get account assignment list
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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
Example HTTP request
Request path
/v1/account-assignments?instance_id={instance_id}&target_account_id={target_account_id}
"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"
]
}
1.18 - ListGroups
1.18.1 - 1.2
get /v1/groups
Description
get groups list
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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"
]
}
1.18.2 - 1.1
get /v1/groups
Description
get groups list
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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"
]
}
1.18.3 - 1.0
get /v1/groups
Description
get groups list
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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"
]
}
1.19 - ListGroupUsers
1.19.1 - 1.2
get /v1/groups/{group_id}/users
Description
get group users list
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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"
}
]
}
1.19.2 - 1.1
get /v1/groups/{group_id}/users
Description
get group users list
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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"
}
]
}
1.19.3 - 1.0
get /v1/groups/{group_id}/users
Description
get group users list
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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"
}
]
}
1.20 - ListInstances
1.20.1 - 1.2
get /v1/instances
Description
get instances list
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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
"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"
]
}
1.20.2 - 1.1
get /v1/instances
Description
get instances list
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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
"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"
]
}
1.20.3 - 1.0
get /v1/instances
Description
get instances list
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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
"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"
]
}
1.21 - ListPermissionSetPolicies
1.21.1 - 1.2
get /v1/permission-sets/{permission_set_id}/policies
Description
get policies to a specific permission set
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies?instance_id={instance_id}
"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"
]
}
1.21.2 - 1.1
get /v1/permission-sets/{permission_set_id}/policies
Description
get policies to a specific permission set
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies?instance_id={instance_id}
"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"
]
}
1.21.3 - 1.0
get /v1/permission-sets/{permission_set_id}/policies
Description
get policies to a specific permission set
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies?instance_id={instance_id}
"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"
]
}
1.22 - ListPermissionSets
1.22.1 - 1.2
get /v1/permission-sets
Description
get permission sets list
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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
Example HTTP request
Request path
/v1/permission-sets?instance_id={instance_id}
"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"
]
}
1.22.2 - 1.1
get /v1/permission-sets
Description
get permission sets list
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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
Example HTTP request
Request path
/v1/permission-sets?instance_id={instance_id}
"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"
]
}
1.22.3 - 1.0
get /v1/permission-sets
Description
get permission sets list
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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
Example HTTP request
Request path
/v1/permission-sets?instance_id={instance_id}
"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"
]
}
1.23 - ListUsers
1.23.1 - 1.2
get /v1/users
Description
get users list
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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"
}
]
}
1.23.2 - 1.1
get /v1/users
Description
get users list
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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"
}
]
}
1.23.3 - 1.0
get /v1/users
Description
get users list
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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"
}
]
}
1.24 - SetGroup
1.24.1 - 1.2
patch /v1/groups/{group_id}
Description
set a specific group
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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"
}
}
1.24.2 - 1.1
patch /v1/groups/{group_id}
Description
set a specific group
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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"
}
}
1.24.3 - 1.0
patch /v1/groups/{group_id}
Description
set a specific group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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"
}
}
1.25 - SetInstance
1.25.1 - 1.2
patch /v1/instances/{instance_id}
Description
set a specific instance
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | instance_id
required | Instance ID
Example : ssoins-12345
| string | None |
| body | body
required |
| InstanceSetRequest1Dot1 | |
Responses
Example HTTP request
Request path
/v1/instances/{instance_id}
"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"
],
"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"
}
}
1.25.2 - 1.1
patch /v1/instances/{instance_id}
Description
set a specific instance
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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
Example HTTP request
Request path
/v1/instances/{instance_id}
"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"
],
"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"
}
}
1.26 - SetPermissionSet
1.26.1 - 1.2
patch /v1/permission-sets/{permission_set_id}
Description
set a specific permission set
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | permission_set_id
required | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| string | None |
| body | body
required |
| PermissionSetSetRequest | |
Responses
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}
"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"
}
1.26.2 - 1.1
patch /v1/permission-sets/{permission_set_id}
Description
set a specific permission set
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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"
}
1.26.3 - 1.0
patch /v1/permission-sets/{permission_set_id}
Description
set a specific permission set
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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"
}
1.27 - SetPermissionSetPolicies
1.27.1 - 1.2
put /v1/permission-sets/{permission_set_id}/policies
Description
set policies to a specific permission set
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
Responses
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies
"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"
}
1.27.2 - 1.1
put /v1/permission-sets/{permission_set_id}/policies
Description
set policies to a specific permission set
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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
"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"
}
1.27.3 - 1.0
put /v1/permission-sets/{permission_set_id}/policies
Description
set policies to a specific permission set
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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
"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"
}
1.28 - SetUser
1.28.1 - 1.2
patch /v1/users/{user_uuid}
Description
set a specific user
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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": "2025-11-24T08:14:51.694996",
"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"
}
}
1.28.2 - 1.1
patch /v1/users/{user_uuid}
Description
set a specific user
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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": "2025-11-24T08:14:51.694996",
"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"
}
}
1.28.3 - 1.0
patch /v1/users/{user_uuid}
Description
set a specific user
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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": "2025-11-24T08:14:51.694996",
"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"
}
}
1.29 - ShowGroup
1.29.1 - 1.2
get /v1/groups/{group_id}
Description
show a specific group
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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"
}
]
}
}
1.29.2 - 1.1
get /v1/groups/{group_id}
Description
show a specific group
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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"
}
]
}
}
1.29.3 - 1.0
get /v1/groups/{group_id}
Description
show a specific group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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"
}
]
}
}
1.30 - ShowInstance
1.30.1 - 1.2
get /v1/instances/{instance_id}
Description
show a specific instance
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | instance_id
required | Instance ID
Example : ssoins-12345
| string | None |
Responses
Example HTTP request
Request path
/v1/instances/{instance_id}
"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"
],
"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"
}
}
1.30.2 - 1.1
get /v1/instances/{instance_id}
Description
show a specific instance
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | instance_id
required | Instance ID
Example : ssoins-12345
| string | None |
Responses
Example HTTP request
Request path
/v1/instances/{instance_id}
"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"
],
"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"
}
}
1.31 - ShowPermissionSet
1.31.1 - 1.2
get /v1/permission-sets/{permission_set_id}
Description
show a specific permission set
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}?instance_id={instance_id}
"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"
}
1.31.2 - 1.1
get /v1/permission-sets/{permission_set_id}
Description
show a specific permission set
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}?instance_id={instance_id}
"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"
}
1.31.3 - 1.0
get /v1/permission-sets/{permission_set_id}
Description
show a specific permission set
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}?instance_id={instance_id}
"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"
}
1.32 - ShowUser
1.32.1 - 1.2
get /v1/users/{user_uuid}
Description
show a specific user
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
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}
"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": "2025-11-24T08:14:51.694996",
"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"
}
}
1.32.2 - 1.1
get /v1/users/{user_uuid}
Description
show a specific user
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 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}
"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": "2025-11-24T08:14:51.694996",
"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"
}
}
1.32.3 - 1.0
get /v1/users/{user_uuid}
Description
show a specific user
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 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}
"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": "2025-11-24T08:14:51.694996",
"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"
}
}
2 - Models
2.1 - Account
| Name | Description | Schema | Default |
|---|
target_account_email
required | Assigned Account Email
Example : target_account@example.com
| string | |
target_account_id
required | Assigned Account ID
Example : 3265ab469f0d406d83073da3e11e7a6c
| string | |
target_account_name
required | Assigned Account Name
Example : target_account@example.com
| string | |
2.2 - AccountAssignment
| Name | Description | Schema | Default |
|---|
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
permission_sets
optional |
| array[AssignmentPermissionSet] | |
principal_id
required | Principal ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
| string | |
principal_name
required | Principal Name
Example : GROUP0407
| string | |
principal_type
required | Principal Type
Example : USER
| enum (USER, GROUP) | |
role_srn
optional | Permission Set Description
Example : Permissions for administrators
| any of [string, null] | |
target_account_email
required | Assigned Account Email
Example : target_account@example.com
| string | |
target_account_id
required | Assigned Account ID
Example : 3265ab469f0d406d83073da3e11e7a6c
| string | |
target_account_name
required | Assigned Account Name
Example : Admin Account
| string | |
2.3 - AccountAssignmentDeleteRequest
| Name | Description | Schema | Default |
|---|
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
only_user_removed
optional | Exclude Directly Applied Only
Example : False
| any of [boolean, null] | |
target_account_id
required | Assigned Account ID
Example : 3265ab469f0d406d83073da3e11e7a6c
| string | |
2.4 - AccountAssignmentsCreateRequest
| Name | Description | Schema | Default |
|---|
accounts
optional |
| array[Account] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
permission_sets
optional |
| array[PermissionSetInfo] | |
principals
optional |
| array[Principal] | |
2.5 - AccountAssignmentsCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|
accounts
optional |
| array[Account] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
permission_sets
optional |
| array[PermissionSetInfoV1Dot2] | |
principals
optional |
| array[Principal] | |
2.6 - AccountAssignmentsCreateResponse
| Name | Description | Schema | Default |
|---|
account_assignment_id
optional | Assignment ID
Example : b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
| any of [string, null] | |
permission_set_id
required | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| string | |
principal_id
optional | Principal ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
| any of [string, null] | |
principal_type
optional | Principal Type
Example : USER
| any of [enum (USER, GROUP), null] | |
role_srn
optional | Permission Set Description
Example : Permissions for administrators
| any of [string, null] | |
target_account_id
required | Assigned Account ID
Example : 3265ab469f0d406d83073da3e11e7a6c
| string | |
2.7 - AccountAssignmentsCreateResponseV1Dot2
| Name | Description | Schema | Default |
|---|
account_assignments
required |
| array[AccountAssignmentSummaryModel] | |
count
optional | total count
Example : 20
| any of [integer, null] | |
links
optional | links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
| any of [array[object], null] | |
2.8 - AccountAssignmentsDeleteRequest
| Name | Description | Schema | Default |
|---|
account_assignment_ids
optional | Assignment ID
Example : ['b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8']
| any of [array[string], null] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
only_user_removed
optional | Exclude Directly Applied Only
Example : False
| any of [boolean, null] | |
target_account_id
required | Assigned Account ID
Example : 3265ab469f0d406d83073da3e11e7a6c
| string | |
2.9 - AccountAssignmentsPageResponse
| Name | Description | Schema | Default |
|---|
account_assignments
required |
| array[AccountAssignment] | |
count
required | count
Example : 20
| integer | |
page
required | page
Example : 0
| integer | |
size
required | size
Example : 20
| integer | |
sort
optional | sort
Example : ['created_at:asc']
| any of [array[string], null] | |
2.10 - AccountAssignmentSummaryModel
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
permission_set_id
required | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| string | |
principal_id
required | Principal ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
| string | |
principal_type
required | Principal Type
Example : USER
| enum (USER, GROUP) | |
target_account_id
required | Assigned Account ID
Example : 3265ab469f0d406d83073da3e11e7a6c
| string | |
2.11 - AssignmentPermissionSet
| Name | Description | Schema | Default |
|---|
account_assignment_id
required | Assignment ID
Example : b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
| string | |
permission_set_id
required | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| string | |
permission_set_name
required | Permission Set Name
Example : Permission Set
| string | |
permission_set_srn
required | Permission Set SRN
Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}
| string | |
2.12 - Group
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
creator_name
required | Creator Name
Example : John Doe
| string | |
description
optional | Group Description
Example : Group for administrators
| any of [string, null] | |
id
required | Group ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
| string | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
modifier_name
required | Modifier Name
Example : Smith
| string | |
name
required | Group Name
Example : Admin_Group
| string | |
2.13 - GroupCreateRequest
| Name | Description | Schema | Default |
|---|
description
optional | Group Description
Example : Group for administrators
| any of [string, null] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
name
required | Group Name
Example : Admin_Group
| string | |
user_uuids
optional | List of User IDs to be added to the group
Example : ['138c2fc8c29a449dbfa8681f8f1d78e2']
| any of [array[string], null] | |
2.14 - GroupDeleteBulkRequest
| Name | Description | Schema | Default |
|---|
group_ids
required | List of Group IDs
Example : ['group-12345', 'group-67890']
| array[string] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
2.15 - GroupDetail
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
creator_name
required | Creator Name
Example : John Doe
| string | |
description
optional | Group Description
Example : Group for administrators
| any of [string, null] | |
id
required | Group ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
| string | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
modifier_name
required | Modifier Name
Example : Smith
| string | |
name
required | Group Name
Example : Admin_Group
| string | |
user_count
optional | Number of Users in the group
Example : 1
| any of [integer, null] | |
users
optional | List of Users in the Group
Example : [{'id': '6fdd2a6d-6f4f-4157-8259-5d55e7dd1269', 'name': 'John Doe', 'user_id': 'johndoe'}]
| any of [array[User], null] | |
2.16 - GroupPageResponse
| Name | Description | Schema | Default |
|---|
count
required | count
Example : 20
| integer | |
groups
required |
| array[GroupDetail] | |
page
required | page
Example : 0
| integer | |
size
required | size
Example : 20
| integer | |
sort
optional | sort
Example : ['created_at:asc']
| any of [array[string], null] | |
2.17 - GroupRemoveResponse
2.18 - GroupSetRequest
| Name | Description | Schema | Default |
|---|
description
optional | Group Description
Example : Group for administrators
| any of [string, null] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
name
optional | Group Name
Example : Admin_Group
| any of [string, null] | |
2.19 - GroupSetResponse
| Name | Description | Schema | Default |
|---|
group
required |
| Group | |
2.21 - GroupSummary
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Group Name
Example : Admin_Group
| string | |
2.22 - GroupUser
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
group_count
optional | Number of Groups the User Belongs To
Example : 2
| any of [integer, null] | |
groups
optional | List of Groups the User Belongs To
Example : [{'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'}]
| any of [array[GroupSummary], null] | |
id
required | User ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Real Name
Example : John Doe
| string | |
user_id
required | User Login ID
Example : johndoe
| string | |
2.23 - GroupUsersPageResponse
| Name | Description | Schema | Default |
|---|
count
required | count
Example : 20
| integer | |
page
required | page
Example : 0
| integer | |
size
required | size
Example : 20
| integer | |
sort
optional | sort
Example : ['created_at:asc']
| any of [array[string], null] | |
users
required |
| array[GroupUser] | |
2.24 - GroupUsersRequest
| Name | Description | Schema | Default |
|---|
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
user_uuids
required | List of User IDs
Example : ['user-12345', 'user-67890']
| array[string] | |
2.25 - Instance
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
id
required | Instance ID
Example : ssoins-12345
| string | |
master_account_id
required | Master Account ID
Example : acc-12345
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
organization_id
required | Organization ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
| string | |
region
required | Region
Example : kr-west1
| string | |
srn
required | Instance SRN
Example : srn:identity-center::prj-01234:kr-west-1::instance/ins-01234
| string | |
state
optional | State
Example : ACTIVE
| enum (ACTIVE, INACTIVE) | ACTIVE |
2.26 - InstanceBaseRequest
| Name | Description | Schema | Default |
|---|
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
2.27 - InstanceCreateRequest
| Name | Description | Schema | Default |
|---|
description
optional | Instance Description
Example : My Instance Description
| any of [string, null] | |
identity_store_config
optional | Identity Store Config
Example : {'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'}
| any of [LdapConfigCreateRequest, null] | |
identity_store_type
optional | Identity Store Type
Example : ACTIVE_DIRECTORY
| enum (IDENTITY_CENTER_DIRECTORY, ACTIVE_DIRECTORY) | ACTIVE_DIRECTORY |
name
required | Instance Name
Example : My Instance
| string | |
2.28 - InstanceDetailAddResourceV1Dot1
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : 1234ab567cd64769e8f9g490hi304891
| any of [string, null] | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
creator_name
required | Creator Name
Example : John Doe
| any of [string, null] | |
delegated_account_id
optional | Delegated Account ID
Example : acc-2353
| any of [string, null] | |
delegated_at
optional | Delegation Date
Example : 2023-10-15 14:30:00
| any of [string (date-time), null] | |
delegated_by
optional | Delegated By
Example : sef2w3c8c29a449dbfa8681f8f1d78e2
| any of [string, null] | |
description
optional | Instance Description
Example : My Instance Description
| any of [string, null] | |
id
required | Instance ID
Example : ssoins-12345
| string | |
identity_store_config
optional | Identity Store Config
Example : {'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'}
| any of [LdapConfig, null] | |
identity_store_id
required | Identity Store ID
Example : d-12345
| string | |
identity_store_type
optional | Identity Store Type
Example : ACTIVE_DIRECTORY
| enum (IDENTITY_CENTER_DIRECTORY, ACTIVE_DIRECTORY) | ACTIVE_DIRECTORY |
last_sync_at
optional | Last Sync Date
Example : 2025-08-06 10:30:00
| any of [string, null] | |
last_sync_status
optional | Last Sync Status
Example : ['CREATED', 'RUNNING', 'FINISHED', 'FAILED', 'NONE']
| any of [enum (CREATED, RUNNING, FINISHED, FAILED, NONE), null] | |
master_account_id
required | Master Account ID
Example : acc-12345
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
modifier_name
required | Modifier Name
Example : Smith
| any of [string, null] | |
name
required | Instance Name
Example : My Instance
| string | |
organization_id
required | Organization ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
| string | |
region
required | Region
Example : kr-west1
| string | |
resource_name
required | Resource Name
Example : resource-name-1
| any of [string, null] | |
resource_type
required | Resource Type [instance | permission-set]
Example : virtual-server
| any of [string, null] |
resource_type_display_name
required | Resource Type Display Name
Example : Virtual Server
| any of [string, null] | |
service
required | Service
Example : virtualserver
| any of [string, null] | |
service_name
required | Service Name
Example : Virtual Server
| any of [string, null] | |
srn
required | Instance SRN
Example : srn:identity-center::prj-01234:kr-west-1::instance/ins-01234
| string | |
sso_start_url
required | SSO Start URL
Example : https://login.e.samsungsdscloud.com/d-12345
| string | |
state
optional | State
Example : ACTIVE
| enum (ACTIVE, INACTIVE) | ACTIVE |
2.29 - InstanceDetailV1Dot1
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
delegated_account_id
optional | Delegated Account ID
Example : acc-2353
| any of [string, null] | |
delegated_at
optional | Delegation Date
Example : 2023-10-15 14:30:00
| any of [string (date-time), null] | |
delegated_by
optional | Delegated By
Example : sef2w3c8c29a449dbfa8681f8f1d78e2
| any of [string, null] | |
description
optional | Instance Description
Example : My Instance Description
| any of [string, null] | |
id
required | Instance ID
Example : ssoins-12345
| string | |
identity_store_config
optional | Identity Store Config
Example : {'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'}
| any of [LdapConfig, null] | |
identity_store_id
required | Identity Store ID
Example : d-12345
| string | |
identity_store_type
optional | Identity Store Type
Example : ACTIVE_DIRECTORY
| enum (IDENTITY_CENTER_DIRECTORY, ACTIVE_DIRECTORY) | ACTIVE_DIRECTORY |
last_sync_at
optional | Last Sync Date
Example : 2025-08-06 10:30:00
| any of [string, null] | |
last_sync_status
optional | Last Sync Status
Example : ['CREATED', 'RUNNING', 'FINISHED', 'FAILED', 'NONE']
| any of [enum (CREATED, RUNNING, FINISHED, FAILED, NONE), null] | |
master_account_id
required | Master Account ID
Example : acc-12345
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Instance Name
Example : My Instance
| string | |
organization_id
required | Organization ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
| string | |
region
required | Region
Example : kr-west1
| string | |
srn
required | Instance SRN
Example : srn:identity-center::prj-01234:kr-west-1::instance/ins-01234
| string | |
sso_start_url
required | SSO Start URL
Example : https://login.e.samsungsdscloud.com/d-12345
| string | |
state
optional | State
Example : ACTIVE
| enum (ACTIVE, INACTIVE) | ACTIVE |
2.30 - InstancePageResponse
| Name | Description | Schema | Default |
|---|
count
required | count
Example : 20
| integer | |
instances
optional |
| array[Instance] | |
page
required | page
Example : 0
| integer | |
size
required | size
Example : 20
| integer | |
sort
optional | sort
Example : ['created_at:asc']
| any of [array[string], null] | |
2.31 - InstanceSetRequest1Dot1
| Name | Description | Schema | Default |
|---|
description
optional | Instance Description
Example : My Instance Description
| any of [string, null] | |
identity_store_config
optional | Identity Store Config
Example : {'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'}
| any of [LdapConfig, null] | |
identity_store_type
optional | Identity Store Type
Example : IDENTITY_CENTER_DIRECTORY
| any of [enum (IDENTITY_CENTER_DIRECTORY, ACTIVE_DIRECTORY), null] | |
name
optional | Instance Name
Example : My Instance
Pattern : ^[a-zA-Z0-9 \+\-\=\,\.\_:/@]*$
| any of [string, null] | |
2.32 - InstanceShowResponseAddResourceV1Dot1
2.33 - InstanceShowResponseV1Dot1
2.34 - LdapConfig
| Name | Description | Schema | Default |
|---|
bind_credential
optional | Bind Password
Example : password
Minimum length : 1
Maximum length : 128
| string | |
bind_dn
optional | Bind DN
Example : CN=Administrator,CN=Users,DC=test,DC=add
Minimum length : 1
Maximum length : 255
| string | |
component_id
optional | Component ID
Example : HYIK7LLKQL2MFK2K8Jb1ew
| any of [string, null] | |
connection_url
optional | LDAP Server URL
Example : ldaps://test.subdomain.company.com:123
Minimum length : 1
Maximum length : 255
| string | |
rdn_ldap_attribute
optional | RDN LDAP Attribute
Example : cn
Minimum length : 1
Maximum length : 64
| string | |
user_object_classes
optional | User Object Classes
Example : person, organizationalPerson, user
Minimum length : 1
Maximum length : 100
| string | |
username_ldap_attribute
optional | Username LDAP Attribute
Example : sAMAccountName
Minimum length : 1
Maximum length : 64
| string | |
users_dn
optional | Users DN
Example : OU=Employees,OU=Accounts,DC=sub,DC=org
Minimum length : 1
Maximum length : 255
| string | |
2.35 - LdapConfigCreateRequest
| Name | Description | Schema | Default |
|---|
bind_credential
optional | Bind Password
Example : password
Minimum length : 1
Maximum length : 128
| string | |
bind_dn
optional | Bind DN
Example : CN=Administrator,CN=Users,DC=test,DC=add
Minimum length : 1
Maximum length : 255
| string | |
connection_url
optional | LDAP Server URL
Example : ldaps://test.subdomain.company.com:123
Minimum length : 1
Maximum length : 255
| string | |
rdn_ldap_attribute
optional | RDN LDAP Attribute
Example : cn
Minimum length : 1
Maximum length : 64
| string | |
user_object_classes
optional | User Object Classes
Example : person, organizationalPerson, user
Minimum length : 1
Maximum length : 100
| string | |
username_ldap_attribute
optional | Username LDAP Attribute
Example : sAMAccountName
Minimum length : 1
Maximum length : 64
| string | |
users_dn
optional | Users DN
Example : OU=Employees,OU=Accounts,DC=sub,DC=org
Minimum length : 1
Maximum length : 255
| string | |
2.36 - ManagedPolicy
| Name | Description | Schema | Default |
|---|
description
optional | Description
Example : description
| any of [string, null] | |
id
required | Policy ID
Example : 37f2e31ff86b415698d7e8eeafab445d
| string | |
name
required | Policy Name
Example : PolicyName
| string | |
2.37 - PermissionSetCreateRequest
| Name | Description | Schema | Default |
|---|
customer_policies
optional | Customer Managed Policy
| array[string] | |
description
optional | Instance Description
Example : My Instance Description
| any of [string, null] | |
inline_policies
optional | Inline Policy
| array[object] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
managed_policies
optional | Managed Policy
| array[ManagedPolicy] | |
name
required | Instance Name
Example : My Instance
| string | |
session_duration
required | Maximum Session Duration
Example : 3600
| integer | |
2.38 - PermissionSetCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|
custom_policies
optional | Customer Managed Policy
| array[string] | |
description
optional | Instance Description
Example : My Instance Description
| any of [string, null] | |
inline_policies
optional | Inline Policy
| array[object] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
managed_policies
optional | Managed Policy
| array[ManagedPolicy] | |
name
required | Instance Name
Example : My Instance
| string | |
session_duration
required | Maximum Session Duration
Example : 3600
| integer | |
2.39 - PermissionSetDetails
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
creator_name
required | Creator Name
Example :
| string | |
customer_policies
optional | Customer Managed Policy
| array[string] | |
description
optional | Permission Set Description
Example : Permissions for administrators
| any of [string, null] | |
id
required | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| string | |
inline_policies
optional | Inline Policy
| array[object] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
managed_policies
optional | Managed Policy
| array[object] | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
modifier_name
required | Modifier Name
Example :
| string | |
name
required | Permission Set Name
Example : Permission Set
| string | |
session_duration
required | Maximum Session Duration
Example : 3600
| integer | |
srn
required | Permission Set SRN
Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}
| string | |
state
optional | State
Example : ACTIVE
| enum (ACTIVE, INACTIVE) | ACTIVE |
2.40 - PermissionSetDetailsPageResponseV1Dot2
| Name | Description | Schema | Default |
|---|
count
required | count
Example : 20
| integer | |
page
required | page
Example : 0
| integer | |
permission_sets
required |
| array[PermissionSetDetailsV1Dot2] | |
size
required | size
Example : 20
| integer | |
sort
optional | sort
Example : ['created_at:asc']
| any of [array[string], null] | |
2.41 - PermissionSetDetailsV1Dot2
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
creator_name
required | Creator Name
Example :
| string | |
custom_policies
optional | Customer Managed Policy
| array[string] | |
description
optional | Permission Set Description
Example : Permissions for administrators
| any of [string, null] | |
id
required | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| string | |
inline_policies
optional | Inline Policy
| array[object] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
managed_policies
optional | Managed Policy
| array[object] | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
modifier_name
required | Modifier Name
Example :
| string | |
name
required | Permission Set Name
Example : Permission Set
| string | |
session_duration
required | Maximum Session Duration
Example : 3600
| integer | |
srn
required | Permission Set SRN
Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}
| string | |
state
optional | State
Example : ACTIVE
| enum (ACTIVE, INACTIVE) | ACTIVE |
2.42 - PermissionSetInfo
| Name | Description | Schema | Default |
|---|
customer_policies
optional | Customer Managed Policy
| array[string] | |
inline_policies
optional | Inline Policy
| array[object] | |
managed_policies
optional | Managed Policy
| array[object] | |
permission_set_id
required | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| string | |
permission_set_name
required | Permission Set Name
Example : Permission Set
| string | |
permission_set_srn
required | Permission Set SRN
Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}
| string | |
session_duration
required | Maximum Session Duration
Example : 3600
| integer | |
2.43 - PermissionSetInfoV1Dot2
| Name | Description | Schema | Default |
|---|
custom_policies
optional | Customer Managed Policy
| array[string] | |
inline_policies
optional | Inline Policy
| array[object] | |
managed_policies
optional | Managed Policy
| array[object] | |
permission_set_id
required | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| string | |
permission_set_name
required | Permission Set Name
Example : Permission Set
| string | |
permission_set_srn
required | Permission Set SRN
Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}
| string | |
session_duration
required | Maximum Session Duration
Example : 3600
| integer | |
2.44 - PermissionSetPoliciesDeleteRequest
| Name | Description | Schema | Default |
|---|
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
policy_ids
required |
| array[string] | |
2.45 - PermissionSetPoliciesPageResponse
| Name | Description | Schema | Default |
|---|
count
required | count
Example : 20
| integer | |
page
required | page
Example : 0
| integer | |
policies
optional |
| array[Policy] | |
size
required | size
Example : 20
| integer | |
sort
optional | sort
Example : ['created_at:asc']
| any of [array[string], null] | |
2.46 - PermissionSetPoliciesPageResponseV1Dot2
| Name | Description | Schema | Default |
|---|
count
required | count
Example : 20
| integer | |
page
required | page
Example : 0
| integer | |
policies
optional |
| array[PolicyV1Dot2] | |
size
required | size
Example : 20
| integer | |
sort
optional | sort
Example : ['created_at:asc']
| any of [array[string], null] | |
2.47 - PermissionSetPoliciesSetRequest
| Name | Description | Schema | Default |
|---|
customer_policies
optional | Customer Managed Policy
Example :
| any of [array[string], null] | |
inline_policies
optional | Inline Policy
Example :
| any of [array[object], null] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
managed_policies
optional | Managed Policy
Example :
| any of [array[object], null] | |
2.48 - PermissionSetPoliciesSetRequestV1Dot2
| Name | Description | Schema | Default |
|---|
custom_policies
optional | Customer Managed Policy
Example :
| any of [array[string], null] | |
inline_policies
optional | Inline Policy
Example :
| any of [array[object], null] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
managed_policies
optional | Managed Policy
Example :
| any of [array[object], null] | |
2.49 - PermissionSets
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
creator_name
required | Creator Name
Example :
| string | |
description
optional | Permission Set Description
Example : Permissions for administrators
| any of [string, null] | |
id
required | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| string | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
modifier_name
required | Modifier Name
Example :
| string | |
name
required | Permission Set Name
Example : Permission Set
| string | |
state
optional | State
Example : ACTIVE
| enum (ACTIVE, INACTIVE) | ACTIVE |
2.50 - PermissionSetSetRequest
| Name | Description | Schema | Default |
|---|
description
optional | Instance Description
Example : My Instance Description
| any of [string, null] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
session_duration
optional | Maximum Session Duration
Example : 3600
| any of [integer, null] | |
2.51 - PermissionSetsPageResponse
| Name | Description | Schema | Default |
|---|
count
required | count
Example : 20
| integer | |
page
required | page
Example : 0
| integer | |
permission_sets
required |
| array[PermissionSets] | |
size
required | size
Example : 20
| integer | |
sort
optional | sort
Example : ['created_at:asc']
| any of [array[string], null] | |
2.52 - Policy
| Name | Description | Schema | Default |
|---|
category
required | Policy Type
Example : INLINE_POLICY
| enum (MANAGED_POLICY, CUSTOMER_POLICY, INLINE_POLICY) | |
contents
optional | JSON Document
Example :
| any of [object, array[object], null] | |
id
required | Policy ID
Example : 37f2e31ff86b415698d7e8eeafab445d
| string | |
name
optional | Policy Name
Example : PolicyName
| any of [string, null] | |
permission_set_id
optional | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| any of [string, null] | |
2.53 - PolicyV1Dot2
| Name | Description | Schema | Default |
|---|
category
required | Policy Type
Example : INLINE_POLICY
| enum (MANAGED_POLICY, CUSTOM_POLICY, INLINE_POLICY) | |
contents
optional | JSON Document
Example :
| any of [object, array[object], null] | |
id
required | Policy ID
Example : 37f2e31ff86b415698d7e8eeafab445d
| string | |
name
optional | Policy Name
Example : PolicyName
| any of [string, null] | |
permission_set_id
optional | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| any of [string, null] | |
2.54 - Principal
| Name | Description | Schema | Default |
|---|
principal_id
required | Principal ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
| string | |
principal_type
required | Principal Type
Example : USER
| enum (USER, GROUP) | |
2.55 - RemoveFailCaused
| Name | Description | Schema | Default |
|---|
error_code
optional | Error Code
Example : NOT_FOUND
| string | - |
failed_caused
optional | Failure Reason
Example : NotFoundError
| string | - |
failed_id
optional | ID
Example : 7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e
| string | - |
failed_name
optional | Name
Example :
| string | |
2.56 - RemoveSuccess
| Name | Description | Schema | Default |
|---|
success_id
optional | ID
Example : 7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e
| string | - |
success_name
optional | Name
Example : test
| string | - |
2.57 - ShowPermissionSetAddResource
| Name | Description | Schema | Default |
|---|
account_id
optional |
Example :
| any of [string, null] | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
creator_name
required | Creator Name
Example :
| string | |
customer_policies
optional | Customer Managed Policy
| array[string] | |
description
optional | Permission Set Description
Example : Permissions for administrators
| any of [string, null] | |
id
required | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| string | |
inline_policies
optional | Inline Policy
| array[object] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
managed_policies
optional | Managed Policy
| array[object] | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
modifier_name
required | Modifier Name
Example :
| string | |
name
required | Permission Set Name
Example : Permission Set
| string | |
resource_name
optional |
Example :
| any of [string, null] | |
resource_type
optional |
Example :
| any of [string, null] | |
resource_type_display_name
optional |
Example :
| any of [string, null] | |
service
optional |
Example :
| any of [string, null] | |
service_name
optional |
Example :
| any of [string, null] | |
session_duration
required | Maximum Session Duration
Example : 3600
| integer | |
srn
required | Permission Set SRN
Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}
| string | |
state
optional | State
Example : ACTIVE
| enum (ACTIVE, INACTIVE) | ACTIVE |
2.58 - ShowPermissionSetAddResourceV1Dot2
| Name | Description | Schema | Default |
|---|
account_id
optional |
Example :
| any of [string, null] | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
creator_name
required | Creator Name
Example :
| string | |
custom_policies
optional | Customer Managed Policy
| array[string] | |
description
optional | Permission Set Description
Example : Permissions for administrators
| any of [string, null] | |
id
required | Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
| string | |
inline_policies
optional | Inline Policy
| array[object] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
managed_policies
optional | Managed Policy
| array[object] | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
modifier_name
required | Modifier Name
Example :
| string | |
name
required | Permission Set Name
Example : Permission Set
| string | |
resource_name
optional |
Example :
| any of [string, null] | |
resource_type
optional |
Example :
| any of [string, null] | |
resource_type_display_name
optional |
Example :
| any of [string, null] | |
service
optional |
Example :
| any of [string, null] | |
service_name
optional |
Example :
| any of [string, null] | |
session_duration
required | Maximum Session Duration
Example : 3600
| integer | |
srn
required | Permission Set SRN
Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}
| string | |
state
optional | State
Example : ACTIVE
| enum (ACTIVE, INACTIVE) | ACTIVE |
2.59 - User
| Name | Description | Schema | Default |
|---|
id
required | User ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
| string | |
name
required | Real Name
Example : John Doe
| string | |
user_id
required | User Login ID
Example : johndoe
| string | |
2.60 - UserCreateRequest
| Name | Description | Schema | Default |
|---|
business_unit
optional | Business Unit
Example : Business Unit A
| any of [string, null] | |
department
optional | Department
Example : Department X
| any of [string, null] | |
description
optional | User Description
Example : Description of John Doe
| any of [string, null] | |
email
optional | User Email
Example : john.doe@example.com
| any of [string, null] | |
employee_id
optional | Employee ID
Example : emp-12345
| any of [string, null] | |
group_ids
optional | List of Groups the User Belongs To
Example : ['39520424-440c-41c0-9b9c-f22b2129f6f9', '80c53fe1-4e27-4cce-92be-151cf0f2873e']
| array[string] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
manager
optional | Manager
Example : Alice Smith
| any of [string, null] | |
name
required | Real Name
Example : John Doe
| string | |
nation_id
optional | Nationality ID
Example : +82
| any of [string, null] | |
password
optional | Password
Example :
| any of [string, null] | |
phone_number
optional | Phone Number
Example : 010-1234-5678
| any of [string, null] | |
temporary_password
optional | Temporary Password Status
Example : True
| boolean | True |
user_id
required | User Login ID
Example : johndoe
| string | |
2.61 - UserDeleteBulkRequest
| Name | Description | Schema | Default |
|---|
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
user_uuids
required | List of User IDs
Example : ['user-12345', 'user-67890']
| array[string] | |
2.62 - UserDetail
| Name | Description | Schema | Default |
|---|
business_unit
optional | Business Unit
Example : Business Unit A
| any of [string, null] | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
creator_name
optional | Creator Name
Example : John Doe
| string | - |
department
optional | Department
Example : Department X
| any of [string, null] | |
description
optional | User Description
Example : Description of John Doe
| any of [string, null] | |
email
optional | User Email
Example : john.doe@example.com
| any of [string, null] | |
email_authenticated
optional | Email Authentication Status
Example : False
| boolean | |
employee_id
optional | Employee ID
Example : emp-12345
| any of [string, null] | |
groups
optional | List of Groups
| any of [array[Group], null] | |
id
required | User ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
| string | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
last_login_at
optional | Last Login Date
Example : 2024-12-19 01:09:05.000
| any of [string (date-time), null] | |
last_password_update_at
optional | Last Password Update Date
Example : 2025-11-24T08:14:51.694996
| any of [string (date-time), null] | |
manager
optional | Manager
Example : Alice Smith
| any of [string, null] | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
modifier_name
optional | Modifier Name
Example : Smith
| string | - |
name
required | Real Name
Example : John Doe
| string | |
nation_id
optional | Nationality ID
Example : +82
| any of [string, null] | |
password
optional | Password
Example :
| any of [string, null] | |
password_failed_count
optional | Password Failure Count
Example : 6
| any of [integer, null] | |
password_reuse_count
optional | Password Reuse Limit Count
Example : 6
| any of [integer, null] | |
phone_authenticated
optional | Phone Authentication Status
Example : False
| boolean | |
phone_number
optional | Phone Number
Example : 010-1234-5678
| any of [string, null] | |
temporary_password
required | Temporary Password Status
Example :
| boolean | |
tz_id
optional | Timezone ID
Example : Asia/Seoul
| any of [string, null] | |
user_id
required | User Login ID
Example : johndoe
| string | |
2.63 - UserPageResponse
| Name | Description | Schema | Default |
|---|
count
required | count
Example : 20
| integer | |
page
required | page
Example : 0
| integer | |
size
required | size
Example : 20
| integer | |
sort
optional | sort
Example : ['created_at:asc']
| any of [array[string], null] | |
users
required |
| array[User] | |
2.64 - UserRemoveResponse
2.65 - UserResponse
| Name | Description | Schema | Default |
|---|
user
required |
| UserDetail | |
2.66 - UserSetRequest
| Name | Description | Schema | Default |
|---|
business_unit
optional | Business Unit
Example : Business Unit A
| any of [string, null] | |
department
optional | Department
Example : Department X
| any of [string, null] | |
description
optional | User Description
Example : Description of John Doe
| any of [string, null] | |
email
optional | User Email
Example : john.doe@example.com
| any of [string, null] | |
employee_id
optional | Employee ID
Example : emp-12345
| any of [string, null] | |
instance_id
required | Instance ID
Example : ssoins-12345
| string | |
manager
optional | Manager
Example : Alice Smith
| any of [string, null] | |
name
optional | Real Name
Example : John Doe
| any of [string, null] | |
nation_id
optional | Nationality ID
Example : +82
| any of [string, null] | |
phone_number
optional | Phone Number
Example : 010-1234-5678
| any of [string, null] | |
tz_id
optional | Timezone ID
Example : Asia/Seoul
| any of [string, null] | |