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

Return to the regular view of this page.

Models

1 - Account

NameDescriptionSchemaDefault
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 - AccountAssignment

NameDescriptionSchemaDefault
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

3 - AccountAssignmentDeleteRequest

NameDescriptionSchemaDefault
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

4 - AccountAssignmentsCreateRequest

NameDescriptionSchemaDefault
accounts
optional

array[Account]
instance_id
required
Instance ID
Example : ssoins-12345
string
permission_sets
optional

array[PermissionSetInfo]
principals
optional

array[Principal]

5 - AccountAssignmentsCreateRequestV1Dot2

NameDescriptionSchemaDefault
accounts
optional

array[Account]
instance_id
required
Instance ID
Example : ssoins-12345
string
permission_sets
optional

array[PermissionSetInfoV1Dot2]
principals
optional

array[Principal]

6 - AccountAssignmentsCreateResponse

NameDescriptionSchemaDefault
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

7 - AccountAssignmentsCreateResponseV1Dot2

NameDescriptionSchemaDefault
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]

8 - AccountAssignmentsDeleteRequest

NameDescriptionSchemaDefault
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

9 - AccountAssignmentsPageResponse

NameDescriptionSchemaDefault
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]

10 - AccountAssignmentSummaryModel

NameDescriptionSchemaDefault
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

11 - AssignmentPermissionSet

NameDescriptionSchemaDefault
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

12 - Group

NameDescriptionSchemaDefault
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

13 - GroupCreateRequest

NameDescriptionSchemaDefault
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]

14 - GroupDeleteBulkRequest

NameDescriptionSchemaDefault
group_ids
required
List of Group IDs
Example : ['group-12345', 'group-67890']
array[string]
instance_id
required
Instance ID
Example : ssoins-12345
string

15 - GroupDetail

NameDescriptionSchemaDefault
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]

16 - GroupPageResponse

NameDescriptionSchemaDefault
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]

17 - GroupRemoveResponse

NameDescriptionSchemaDefault
failed_ids
required
Failure Reason
array[RemoveFailCaused]
success_ids
required
List of Successful IDs
array[RemoveSuccess]

18 - GroupSetRequest

NameDescriptionSchemaDefault
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]

19 - GroupSetResponse

NameDescriptionSchemaDefault
group
required

Group

20 - GroupShowResponse

NameDescriptionSchemaDefault
group
required

GroupDetail

21 - GroupSummary

NameDescriptionSchemaDefault
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

22 - GroupUser

NameDescriptionSchemaDefault
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

23 - GroupUsersPageResponse

NameDescriptionSchemaDefault
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]

24 - GroupUsersRequest

NameDescriptionSchemaDefault
instance_id
required
Instance ID
Example : ssoins-12345
string
user_uuids
required
List of User IDs
Example : ['user-12345', 'user-67890']
array[string]

25 - Instance

NameDescriptionSchemaDefault
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

26 - InstanceBaseRequest

NameDescriptionSchemaDefault
instance_id
required
Instance ID
Example : ssoins-12345
string

27 - InstanceCreateRequest

NameDescriptionSchemaDefault
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

28 - InstanceDetailAddResourceV1Dot1

NameDescriptionSchemaDefault
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 [instancepermission-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

29 - InstanceDetailV1Dot1

NameDescriptionSchemaDefault
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

30 - InstancePageResponse

NameDescriptionSchemaDefault
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]

31 - InstanceSetRequest1Dot1

NameDescriptionSchemaDefault
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]

32 - InstanceShowResponseAddResourceV1Dot1

NameDescriptionSchemaDefault
instance
required

InstanceDetailAddResourceV1Dot1

33 - InstanceShowResponseV1Dot1

NameDescriptionSchemaDefault
instance
required

InstanceDetailV1Dot1

34 - LdapConfig

NameDescriptionSchemaDefault
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

35 - LdapConfigCreateRequest

NameDescriptionSchemaDefault
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

36 - ManagedPolicy

NameDescriptionSchemaDefault
description
optional
Description
Example : description
any of [string, null]
id
required
Policy ID
Example : 37f2e31ff86b415698d7e8eeafab445d
string
name
required
Policy Name
Example : PolicyName
string

37 - PermissionSetCreateRequest

NameDescriptionSchemaDefault
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

38 - PermissionSetCreateRequestV1Dot2

NameDescriptionSchemaDefault
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

39 - PermissionSetDetails

NameDescriptionSchemaDefault
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

40 - PermissionSetDetailsPageResponseV1Dot2

NameDescriptionSchemaDefault
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]

41 - PermissionSetDetailsV1Dot2

NameDescriptionSchemaDefault
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

42 - PermissionSetInfo

NameDescriptionSchemaDefault
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

43 - PermissionSetInfoV1Dot2

NameDescriptionSchemaDefault
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

44 - PermissionSetPoliciesDeleteRequest

NameDescriptionSchemaDefault
instance_id
required
Instance ID
Example : ssoins-12345
string
policy_ids
required

array[string]

45 - PermissionSetPoliciesPageResponse

NameDescriptionSchemaDefault
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]

46 - PermissionSetPoliciesPageResponseV1Dot2

NameDescriptionSchemaDefault
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]

47 - PermissionSetPoliciesSetRequest

NameDescriptionSchemaDefault
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]

48 - PermissionSetPoliciesSetRequestV1Dot2

NameDescriptionSchemaDefault
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]

49 - PermissionSets

NameDescriptionSchemaDefault
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

50 - PermissionSetSetRequest

NameDescriptionSchemaDefault
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]

51 - PermissionSetsPageResponse

NameDescriptionSchemaDefault
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]

52 - Policy

NameDescriptionSchemaDefault
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]

53 - PolicyV1Dot2

NameDescriptionSchemaDefault
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]

54 - Principal

NameDescriptionSchemaDefault
principal_id
required
Principal ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
string
principal_type
required
Principal Type
Example : USER
enum (USER, GROUP)

55 - RemoveFailCaused

NameDescriptionSchemaDefault
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

56 - RemoveSuccess

NameDescriptionSchemaDefault
success_id
optional
ID
Example : 7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e
string-
success_name
optional
Name
Example : test
string-

57 - ShowPermissionSetAddResource

NameDescriptionSchemaDefault
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

58 - ShowPermissionSetAddResourceV1Dot2

NameDescriptionSchemaDefault
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

59 - User

NameDescriptionSchemaDefault
id
required
User ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
string
name
required
Real Name
Example : John Doe
string
user_id
required
User Login ID
Example : johndoe
string

60 - UserCreateRequest

NameDescriptionSchemaDefault
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
booleanTrue
user_id
required
User Login ID
Example : johndoe
string

61 - UserDeleteBulkRequest

NameDescriptionSchemaDefault
instance_id
required
Instance ID
Example : ssoins-12345
string
user_uuids
required
List of User IDs
Example : ['user-12345', 'user-67890']
array[string]

62 - UserDetail

NameDescriptionSchemaDefault
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

63 - UserPageResponse

NameDescriptionSchemaDefault
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]

64 - UserRemoveResponse

NameDescriptionSchemaDefault
failed_ids
required
Failure Reason
array[RemoveFailCaused]
success_ids
required
List of Successful IDs
array[RemoveSuccess]

65 - UserResponse

NameDescriptionSchemaDefault
user
required

UserDetail

66 - UserSetRequest

NameDescriptionSchemaDefault
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]