This is the multi-page printable view of this section. Click here to print.
Models
- 1: AccessKey
- 2: AccessKeyCreateRequest
- 3: AccessKeyModel
- 4: AccessKeyOtpRequest
- 5: AccessKeyResponse
- 6: AccessKeyUpdateRequest
- 7: AccessKeyWithSecretVaultModel
- 8: CreatedGroupMember
- 9: EndpointsResponse
- 10: Group
- 11: GroupCreateRequest
- 12: GroupMember
- 13: GroupMemberCreateRequest
- 14: GroupMemberCreateResponse
- 15: GroupMemberPageResponse
- 16: GroupMemberPageResponseV1Dot4
- 17: GroupMemberV1Dot4
- 18: GroupPageResponse
- 19: GroupPolicyBindingRequest
- 20: GroupPolicyPageResponse
- 21: GroupPolicyResponse
- 22: GroupSetRequest
- 23: GroupShowResponse
- 24: IAMCreateUserResponse
- 25: IamPolicyDocument
- 26: IAMUserCreateRequest
- 27: IAMUserDeleteRequest
- 28: IAMUserDetailResponse
- 29: IAMUserDetailResponseV1Dot4
- 30: IAMUserGroupInfo
- 31: IAMUserPasswordUpdateRequest
- 32: IAMUserResponse
- 33: IAMUserResponseV1Dot4
- 34: IAMUserUpdateRequest
- 35: IAMUserWithoutPolicyResponseV1Dot4
- 36: ListAccessKeyRemoveRequest
- 37: ListAccessKeyResponse
- 38: ListEndpointsResponse
- 39: ListIAMUserResponse
- 40: ListIAMUserResponseV1Dot4
- 41: ListPolicyRemoveRequest
- 42: ListSamlProviderRemoveRequest
- 43: ListSamlProviderResponse
- 44: Policy
- 45: PolicyBasic
- 46: PolicyBindingPageResponse
- 47: PolicyBindingPageResponseV1Dot4
- 48: PolicyBindingSetRequest
- 49: PolicyCreateRequest
- 50: PolicyDocument
- 51: PolicyPageResponse
- 52: PolicyQueryRequest
- 53: PolicySetRequest
- 54: PolicyShowResponse
- 55: PolicyVersion
- 56: PolicyVersionCreateRequest
- 57: ResourcePolicySetRequest
- 58: ResourcePolicyShowResponse
- 59: ResourcePolicyVersion
- 60: ResourcePolicyVersionCreateRequest
- 61: Role
- 62: RoleBulkDeleteRequest
- 63: RoleCreateRequest
- 64: RoleCreateRequestV1Dot3
- 65: RolePageResponse
- 66: RolePolicyBindingPageResponse
- 67: RolePolicyBindingRequest
- 68: RolePolicyBindingResponse
- 69: RoleSetRequest
- 70: RoleShowResponse
- 71: RoleTrustPolicyPrincipal
- 72: RoleTrustPolicyRequest
- 73: RoleTrustPolicyShowResponse
- 74: SamlProviderCreateRequest
- 75: SamlProviderCreateResponse
- 76: SamlProviderDetailResponse
- 77: SamlProviderResponse
- 78: SamlProviderUpdateRequestData
- 79: ServiceAccount
- 80: ServiceAccountDetail
- 81: ServiceAccountListResponse
- 82: ServiceAccountShowResponse
- 83: Statement
- 84: StatementCreateRequest
- 85: StatementResponse
- 86: UserPolicyPageResponse
- 87: UserPolicyRequest
- 88: UserPolicyResponse
- 89: UserResponse
1 - AccessKey
| Name | Description | Schema | Default |
|---|---|---|---|
| access_key required | Access Key Example : b754b12b39da4ce29a40c5e324650bd0 | string | |
| access_key_type required | Access Key Type Example : PERMANENT | enum (PERMANENT, TEMPORARY, SECRET_VAULT_TEMPORARY) | |
| account_id required | Account Id Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | Description Example : description | any of [string, null] | |
| expiration_timestamp required | Access Key Expiration Timestamp Example : 9999-12-31T23:59:59Z | string (date-time) | |
| id required | ID Example : 6558fc9df5b54c8a985465bdf637e097 | string | |
| is_enabled required | Activation Status Example : true | boolean | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| parent_access_key_id required | Parent Access Key ID Used for Temporary Access Key Creation Example : 92d6eid9e9ae4f868s842910k11573a3 | any of [string, null] | |
| secret_key required | Secret Key Example : c4150149-f7c6-46bc-9faa-d2b9d20e0899 | string |
2 - AccessKeyCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| access_key_type required | Access Key Type Example : PERMANENT | enum (PERMANENT, TEMPORARY) | |
| account_id optional | Account Id Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| description optional | Description Example : description | any of [string, null] | |
| duration optional | Expiration Duration Example : P1Y2M10DT2H30M15S | any of [string, null] | |
| parent_access_key_id optional | Required Access Key for Creating Temporary Access Key Example : 92d6eid9e9ae4f868s842910k11573a3 | any of [string, null] | |
| passcode optional | Required for Temporary Access Key Example : 000000 | any of [string, null] |
3 - AccessKeyModel
| Name | Description | Schema | Default |
|---|---|---|---|
| access_key required | Access Key Example : b754b12b39da4ce29a40c5e324650bd0 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17 | string (date-time) | |
| expiration_timestamp required | Access Key Expiration Timestamp Example : 9999-12-31T23:59:59 | string (date-time) | |
| id required | ID Example : 6558fc9df5b54c8a985465bdf637e097 | string | |
| is_enabled required | Activation Status Example : true | boolean |
4 - AccessKeyOtpRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| locale optional | Locale Example : ko_KR | enum (ko_KR, en_US) | |
| method optional | OTP Method (EMAIL or PHONE) Example : PHONE | enum (PHONE, EMAIL, MESSENGER) |
5 - AccessKeyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| access_key required | AccessKey |
6 - AccessKeyUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| is_enabled optional | Activation Status Example : true | boolean | True |
7 - AccessKeyWithSecretVaultModel
| Name | Description | Schema | Default |
|---|---|---|---|
| access_key required | Access Key Example : b754b12b39da4ce29a40c5e324650bd0 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17 | string (date-time) | |
| expiration_timestamp required | Access Key Expiration Timestamp Example : 9999-12-31T23:59:59 | string (date-time) | |
| id required | ID Example : 6558fc9df5b54c8a985465bdf637e097 | string | |
| is_enabled required | Activation Status Example : true | boolean | |
| secret_vault required | Secret Vault Status Example : true | boolean |
8 - CreatedGroupMember
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Creator Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| creator_email optional | Creator Email Example : samsung.kim@samsung.com | string | - |
| creator_name optional | Creator Last Name, First Name Example : Kim Samsung | string | - |
| user_email optional | Group Member Email Example : samsung.kim@samsung.com | string | - |
| user_id required | User ID Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| user_name optional | Group Member Last Name, First Name Example : Kim Samsung | string | - |
9 - EndpointsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| region required | Region Example : kr-west1 | string | |
| service_name required | Service Name Example : scp-iam | string | |
| service_type required | Service Type Example : scp-iam | string | |
| url required | URL Example : https://iam.dev2.samsungsdscloud.com | string |
10 - Group
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Creator Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| creator_email optional | Creator Email Example : samsung.kim@samsung.com | string | - |
| creator_name optional | Creator Last Name, First Name Example : Kim Samsung | string | - |
| description required | Group Description Example : Descriptions for group | any of [string, null] | |
| domain_name required | Domain Name Example : scp | string | |
| id required | ID Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| members optional | Group Member List | any of [array[GroupMember], null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modifier Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| modifier_email optional | Modifier Email Example : samsung.kim@samsung.com | string | - |
| modifier_name optional | Modifier Last Name, First Name Example : Kim Samsung | string | - |
| name required | Group Name Example : TestGroupPattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 24 | string | |
| policies required | Policy | any of [array[Policy], null] | |
| resource_type optional | Resource Name Example : group | any of [string, null] | group |
| roles required | Role Information | any of [array[Role], null] | |
| service_name optional | Service Name Example : Identity Access Management | any of [string, null] | Identity Access Management |
| service_type optional | Service Type Example : iam | any of [string, null] | iam |
| srn optional | Samsung Resource Name Example : srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda | any of [string, null] | |
| type required | Group Types Example : USER_DEFINED | string |
11 - GroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Group Description Example : Descriptions for group | any of [string, null] | |
| name required | Group Name Example : TestGroupPattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 24 | string | |
| policy_ids optional | Group Policy ID List Example : ['37f2e31ff86b415698d7e8eeafab445d'] | any of [array[string], null] | |
| tags optional | Group Tag Example : [{'key': 'company', 'value': 'SDS'}] | any of [array[object[string]], null] | |
| user_ids optional | Group Member User ID List Example : ['f39c460fade34fecb05ede8f904b24b7'] | any of [array[string], null] |
12 - GroupMember
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Creator Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| creator_created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| creator_email optional | Creator Email Example : samsung.kim@samsung.com | string | - |
| creator_last_login_at optional | Group Member Last Login At Example : 2024-05-17T00:23:17Z | any of [string (date-time), null] | |
| creator_name optional | Creator Last Name, First Name Example : Kim Samsung | string | - |
| group_names optional | Group Names Example : ['TestGroup', 'SampleGroup'] | array[string] | |
| user_created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| user_email optional | Group Member Email Example : samsung.kim@samsung.com | string | - |
| user_id required | User ID Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| user_last_login_at optional | Group Member Last Login At Example : 2024-05-17T00:23:17Z | any of [string (date-time), null] | |
| user_name optional | Group Member Last Name, First Name Example : Kim Samsung | string | - |
13 - GroupMemberCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| user_id required | Group Member User ID Example : f39c460fade34fecb05ede8f904b24b7 | string |
14 - GroupMemberCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| group_member required | CreatedGroupMember |
15 - GroupMemberPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| group_members required | array[GroupMember] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
16 - GroupMemberPageResponseV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| group_members required | array[GroupMemberV1Dot4] | ||
| 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 - GroupMemberV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Creator Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| creator_created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| creator_email optional | Creator Email Example : samsung.kim@samsung.com | string | - |
| creator_last_login_at optional | Group Member Last Login At Example : 2024-05-17T00:23:17Z | any of [string (date-time), null] | |
| creator_name optional | Creator Last Name, First Name Example : Kim Samsung | string | - |
| groups optional | Group Members Example : [{'id': 'a946662dc4314dac93da413a32457459', 'name': 'TestGroup'}] | array[IAMUserGroupInfo] | |
| user_created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| user_email optional | Group Member Email Example : samsung.kim@samsung.com | string | - |
| user_id required | User ID Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| user_last_login_at optional | Group Member Last Login At Example : 2024-05-17T00:23:17Z | any of [string (date-time), null] | |
| user_name optional | Group Member Last Name, First Name Example : Kim Samsung | string | - |
18 - GroupPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| groups required | array[Group] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
19 - GroupPolicyBindingRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_ids required | Group Policy ID List Example : ['37f2e31ff86b415698d7e8eeafab445d'] | array[string] |
20 - GroupPolicyPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies required | array[Policy] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
21 - GroupPolicyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| policies required | array[Policy] |
22 - GroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Group Description Example : Descriptions for group | any of [string, null] | |
| name required | Group Name Example : TestGroupPattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 24 | string |
23 - GroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| group required | Group |
24 - IAMCreateUserResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| company_name optional | Company Name Example : | any of [string, null] | |
| console_url required | Console URL Example : | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | User Description Example : | any of [string, null] | |
| dst_offset optional | DST Offset Example : | any of [string, null] | |
| email optional | User Email Example : | any of [string, null] | |
| email_authenticated required | Email Authentication Status Example : | boolean | |
| first_name optional | User Name Example : | any of [string, null] | |
| id required | ID Example : | string | |
| last_login_at optional | Last Login Example : | any of [string (date-time), null] | |
| last_name optional | User Last Name Example : | any of [string, null] | |
| last_password_update_at optional | Last Password Update Time Example : | any of [string (date-time), null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | Name Example : | any of [string, null] | |
| password required | Password Example : | string | |
| password_reuse_count required | Password Reuse Count Example : | integer | |
| phone_authenticated required | Phone Authentication Status Example : | boolean | |
| policies required | User Policies | any of [array[Policy], null] | |
| state optional | Status Example : | any of [string, null] | |
| timezone optional | Timezone ID Example : | any of [string, null] | |
| type required | Type Example : | string | |
| tz_id optional | Timezone ID Example : | any of [string, null] | |
| user_name optional | User Name Example : | any of [string, null] | |
| utc_offset optional | UTC Offset Example : | any of [string, null] |
25 - IamPolicyDocument
| Name | Description | Schema | Default |
|---|---|---|---|
| Statement required | Statement | array[Statement] | |
| Version required | Policy Version Example : 2024-07-01 | string |
26 - IAMUserCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | User Description Example : | any of [string, null] | |
| group_ids optional | Group IDs Example : | any of [array[string], null] | |
| password required | Password Example : | string | |
| policy_ids optional | Policy IDs Field Example : | any of [array[string], null] | |
| tags optional | User Tag Example : | any of [array[object[string]], null] | |
| temporary_password required | Temporary Example : | boolean | |
| user_name required | User Name Example : Pattern : ^[a-zA-Z0-9\+\.\@\-\_]*$Maximum length : 64 | string |
27 - IAMUserDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| user_ids optional | User ID List Example : | any of [array[string], null] |
28 - IAMUserDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| company_name optional | Company Name 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 | |
| created_by_name optional | Creator Last Name, First Name Example : | any of [string, null] | |
| description optional | User Description Example : | any of [string, null] | |
| dst_offset optional | DST Offset Example : | any of [string, null] | |
| email optional | User Email Example : | any of [string, null] | |
| email_authenticated required | Email Authentication Status Example : | boolean | |
| first_name optional | User Name Example : | any of [string, null] | |
| id required | ID Example : | string | |
| last_login_at optional | Last Login Example : | any of [string (date-time), null] | |
| last_name optional | User Last Name Example : | any of [string, null] | |
| last_password_update_at optional | Last Password Update Time Example : | any of [string (date-time), null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modified_by_name optional | Modifier Last Name, First Name Example : | any of [string, null] | |
| name optional | Name Example : | any of [string, null] | |
| password_reuse_count required | Password Reuse Count Example : | integer | |
| phone_authenticated required | Phone Authentication Status Example : | boolean | |
| policies required | User Policies | any of [array[Policy], null] | |
| resource_type optional | Service Example : User | any of [string, null] | User |
| service optional | Service Example : iam | any of [string, null] | iam |
| service_name optional | Service Name Example : Identity Access Management | any of [string, null] | Identity Access Management |
| srn required | Samsung Resource Name Example : | any of [string, null] | |
| state optional | Status Example : | any of [string, null] | |
| timezone optional | Timezone ID Example : | any of [string, null] | |
| type required | Type Example : | string | |
| tz_id optional | Timezone ID Example : | any of [string, null] | |
| user_name optional | User Name Example : | any of [string, null] | |
| utc_offset optional | UTC Offset Example : | any of [string, null] |
29 - IAMUserDetailResponseV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| access_keys optional | Access Keys | any of [array[AccessKeyWithSecretVaultModel], null] | |
| account_id optional | Account ID Example : | any of [string, null] | |
| company_name optional | Company Name 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 | |
| created_by_name optional | Creator Last Name, First Name Example : | any of [string, null] | |
| description optional | User Description Example : | any of [string, null] | |
| dst_offset optional | DST Offset Example : | any of [string, null] | |
| email optional | User Email Example : | any of [string, null] | |
| email_authenticated required | Email Authentication Status Example : | boolean | |
| first_name optional | User Name Example : | any of [string, null] | |
| id required | ID Example : | string | |
| last_login_at optional | Last Login Example : | any of [string (date-time), null] | |
| last_name optional | User Last Name Example : | any of [string, null] | |
| last_password_update_at optional | Last Password Update Time Example : | any of [string (date-time), null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modified_by_name optional | Modifier Last Name, First Name Example : | any of [string, null] | |
| name optional | Name Example : | any of [string, null] | |
| password_reuse_count required | Password Reuse Count Example : | integer | |
| phone_authenticated required | Phone Authentication Status Example : | boolean | |
| policies required | User Policies | any of [array[Policy], null] | |
| resource_type optional | Service Example : User | any of [string, null] | User |
| service optional | Service Example : iam | any of [string, null] | iam |
| service_name optional | Service Name Example : Identity Access Management | any of [string, null] | Identity Access Management |
| srn required | Samsung Resource Name Example : | any of [string, null] | |
| state optional | Status Example : | any of [string, null] | |
| timezone optional | Timezone ID Example : | any of [string, null] | |
| type required | Type Example : | string | |
| tz_id optional | Timezone ID Example : | any of [string, null] | |
| user_name optional | User Name Example : | any of [string, null] | |
| utc_offset optional | UTC Offset Example : | any of [string, null] |
30 - IAMUserGroupInfo
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Group ID Example : | string | |
| name required | Group Name Example : | string |
31 - IAMUserPasswordUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| password required | Password Example : | string | |
| temporary_password optional | Temporary Example : False | any of [boolean, null] |
32 - IAMUserResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| company_name optional | Company Name 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 | |
| description optional | User Description Example : | any of [string, null] | |
| dst_offset optional | DST Offset Example : | any of [string, null] | |
| email optional | User Email Example : | any of [string, null] | |
| email_authenticated required | Email Authentication Status Example : | boolean | |
| first_name optional | User Name Example : | any of [string, null] | |
| groups optional | Group Names Example : | any of [array[string], null] | |
| id required | ID Example : | string | |
| last_login_at optional | Last Login Example : | any of [string (date-time), null] | |
| last_name optional | User Last Name Example : | any of [string, null] | |
| last_password_update_at optional | Last Password Update Time Example : | any of [string (date-time), null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | Name Example : | any of [string, null] | |
| password_reuse_count required | Password Reuse Count Example : | integer | |
| phone_authenticated required | Phone Authentication Status Example : | boolean | |
| policies required | User Policies | any of [array[Policy], null] | |
| state optional | Status Example : | any of [string, null] | |
| timezone optional | Timezone ID Example : | any of [string, null] | |
| type required | Type Example : | string | |
| tz_id optional | Timezone ID Example : | any of [string, null] | |
| user_name optional | User Name Example : | any of [string, null] | |
| utc_offset optional | UTC Offset Example : | any of [string, null] |
33 - IAMUserResponseV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| access_keys optional | Access Keys | any of [array[AccessKeyModel], null] | |
| account_id optional | Account ID Example : | any of [string, null] | |
| company_name optional | Company Name 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 | |
| description optional | User Description Example : | any of [string, null] | |
| dst_offset optional | DST Offset Example : | any of [string, null] | |
| email optional | User Email Example : | any of [string, null] | |
| email_authenticated required | Email Authentication Status Example : | boolean | |
| first_name optional | User Name Example : | any of [string, null] | |
| groups optional | groups | any of [array[IAMUserGroupInfo], null] | |
| id required | ID Example : | string | |
| last_login_at optional | Last Login Example : | any of [string (date-time), null] | |
| last_name optional | User Last Name Example : | any of [string, null] | |
| last_password_update_at optional | Last Password Update Time Example : | any of [string (date-time), null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | Name Example : | any of [string, null] | |
| password_reuse_count required | Password Reuse Count Example : | integer | |
| phone_authenticated required | Phone Authentication Status Example : | boolean | |
| policies required | User Policies | any of [array[Policy], null] | |
| state optional | Status Example : | any of [string, null] | |
| timezone optional | Timezone ID Example : | any of [string, null] | |
| type required | Type Example : | string | |
| tz_id optional | Timezone ID Example : | any of [string, null] | |
| user_name optional | User Name Example : | any of [string, null] | |
| utc_offset optional | UTC Offset Example : | any of [string, null] |
34 - IAMUserUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | User Description Example : | any of [string, null] | |
| password_reuse_count required | Password Reuse Count Example : Maximum : 24 | integer |
35 - IAMUserWithoutPolicyResponseV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| access_keys optional | Access Keys | any of [array[AccessKeyModel], null] | |
| account_id optional | Account ID Example : | any of [string, null] | |
| company_name optional | Company Name 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 | |
| description optional | User Description Example : | any of [string, null] | |
| dst_offset optional | DST Offset Example : | any of [string, null] | |
| email optional | User Email Example : | any of [string, null] | |
| email_authenticated required | Email Authentication Status Example : | boolean | |
| first_name optional | User Name Example : | any of [string, null] | |
| groups optional | groups | any of [array[IAMUserGroupInfo], null] | |
| id required | ID Example : | string | |
| last_login_at optional | Last Login Example : | any of [string (date-time), null] | |
| last_name optional | User Last Name Example : | any of [string, null] | |
| last_password_update_at optional | Last Password Update Time Example : | any of [string (date-time), null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | Name Example : | any of [string, null] | |
| password_reuse_count required | Password Reuse Count Example : | integer | |
| phone_authenticated required | Phone Authentication Status Example : | boolean | |
| policies required | User Policies | any of [array[PolicyBasic], null] | |
| state optional | Status Example : | any of [string, null] | |
| timezone optional | Timezone ID Example : | any of [string, null] | |
| type required | Type Example : | string | |
| tz_id optional | Timezone ID Example : | any of [string, null] | |
| user_name optional | User Name Example : | any of [string, null] | |
| utc_offset optional | UTC Offset Example : | any of [string, null] |
36 - ListAccessKeyRemoveRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| ids optional | Access Key ID List | array[string] | |
| limit optional | limit Example : 20 | any of [integer, null] | |
| marker optional | marker Example : 607e0938521643b5b4b266f343fae693 | any of [string, null] | |
| sort optional | sort Example : created_at:desc | any of [string, null] | |
| with_count optional | with count Example : true | any of [string, null] |
37 - ListAccessKeyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| access_keys required | array[AccessKey] | ||
| count optional | total count Example : 20 | any of [integer, null] | |
| links optional | Links Example : [{'href': 'http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20', 'rel': 'first'}, {'href': 'http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20', 'rel': 'self'}] | any of [array[object], null] |
38 - ListEndpointsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| endpoints required | array[EndpointsResponse] |
39 - ListIAMUserResponse
| 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[IAMUserResponse] |
40 - ListIAMUserResponseV1Dot4
| 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[IAMUserWithoutPolicyResponseV1Dot4] |
41 - ListPolicyRemoveRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| ids optional | ID List Example : ['37f2e31ff86b415698d7e8eeafab445d'] | array[string] |
42 - ListSamlProviderRemoveRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| ids optional | Credential Provider ID List | array[string] |
43 - ListSamlProviderResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| saml_providers required | array[SamlProviderResponse] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
44 - Policy
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account Id Example : e99c73a8690d4ae39ae75e38a26f2b99 | 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_email optional | Creator Email Example : samsung.kim@samsung.com | any of [string, null] | - |
| creator_name optional | Creator Last Name, First Name Example : Kim Samsung | any of [string, null] | |
| default_version_id optional | Default Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | string | |
| description optional | Description Example : Descriptions for policy | any of [string, null] | |
| domain_name required | Domain Name Example : scp | string | |
| id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_email optional | Modifier Email Example : samsung.kim@samsung.com | any of [string, null] | - |
| modifier_name optional | Modifier Last Name, First Name Example : Kim Samsung | any of [string, null] | |
| policy_category optional | Policy Category Example : IDENTITY_BASED | enum (IDENTITY_BASED, RESOURCE_BASED, SESSION) | |
| policy_name optional | Policy Name Example : PolicyNamePattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 128 | string | |
| policy_type optional | Policy Type Example : USER_DEFINED | enum (SYSTEM_MANAGED, USER_DEFINED, INLINE) | |
| policy_versions optional | Policy Versions | array[PolicyVersion] | |
| resource_type optional | Resource Type Example : policy | any of [string, null] | policy |
| service_name optional | Service Name Example : Identity Access Management | any of [string, null] | Identity Access Management |
| service_type optional | Service Type Example : iam | any of [string, null] | iam |
| srn required | Samsung Resource Name Example : srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d | string | |
| state optional | Policy State Example : ACTIVE | enum (ACTIVE, INACTIVE, DELETED) | ACTIVE |
45 - PolicyBasic
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| name optional | Service Name Example : iam | string |
46 - PolicyBindingPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| groups optional | Group Example : [{'created_at': '2025-03-26T10:18:04Z', 'created_by': '4a816a3f5099442ebb52daefc1f7be32', 'creator_email': '-', 'creator_name': '-', 'description': 'openapi-ga2-test-group', 'domain_name': 'scp', 'id': '19fca177a57940daa5817960373c6542', 'modified_at': '2025-03-26T10:18:04Z', 'modified_by': '4a816a3f5099442ebb52daefc1f7be32', 'modifier_email': '-', 'modifier_name': '-', 'name': 'openapi-ga2-testgroup5', 'policies': [], 'roles': [], 'srn': 'srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542', 'type': 'USER_DEFINED'}] | any of [Group, null] | |
| page required | page Example : 0 | integer | |
| policy_id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| roles optional | Role Example : [{'account_id': 'd7aba97100564b34a0f4f77c4bc7a303', 'assume_role_policy_document': {'Statement': [{'Action': '*', 'Condition': {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}, 'Effect': 'Allow', 'NotAction': '*', 'Principal': '*', 'Resource': '*', 'Sid': 'statement1'}], 'Version': '2024-07-01'}, 'created_at': '2024-05-17T00:23:17Z', 'created_by': 'ef50cdc207f05f6fb8f20219f229ed1f', 'creator_email': '-', 'creator_name': '-', 'description': 'string', 'id': 'f39c460fade34fecb05ede8f904b24b7', 'max_session_duration': 0, 'modified_at': '2024-05-17T00:23:17Z', 'modified_by': 'ef50cdc207f05f6fb8f20219f229ed1f', 'modifier_email': '-', 'modifier_name': '-', 'name': 'string', 'type': 'DEFAULT'}] | any of [Role, null] | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| users optional | User Example : [{'access_control': False, 'account_id': 'd7aba97100564b34a0f4f77c4bc7a303', 'account_name': '', 'allowed_ip_addresses': '', 'company_name': '', 'created_at': '2024-11-15T06:57:42.000000Z', 'created_by': '90dddfc2b1e04edba54ba2b41539a9ac', 'description': '', 'domain_name': 'scp', 'dst_offset': '+09:00', 'email': 'samsung.kim@samsung.com', 'email_authenticate_code': '8ada8861bad2423295e4bb576bee5886', 'email_authenticated': True, 'first_name': '', 'groups': [], 'id': '90dddfc2b1e04edba54ba2b41539a9ac', 'keycloak_id': '127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507', 'keystone_credential': '', 'last_login_at': '2024-11-25T06:57:42.000000Z', 'last_name': '', 'last_password_update_at': '', 'login_id': '', 'modified_at': '2024-11-17T06:57:42.000000Z', 'modified_by': '90dddfc2b1e04edba54ba2b41539a9ac', 'nation_id': '+82', 'phone_authenticated': False, 'phone_number': '0000000000', 'policies': [], 'state': 'ACTIVE', 'temporary_password': False, 'term_region_id': '1', 'timezone': 'Asia/Seoul', 'type': 'IAM', 'tz_id': 'Asia/Seoul', 'user_name': 'Kim Samsung', 'utc_offset': '+09:00'}] | any of [UserResponse, null] |
47 - PolicyBindingPageResponseV1Dot4
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| groups optional | Group Example : [{'created_at': '2025-03-26T10:18:04Z', 'created_by': '4a816a3f5099442ebb52daefc1f7be32', 'creator_email': '-', 'creator_name': '-', 'description': 'openapi-ga2-test-group', 'domain_name': 'scp', 'id': '19fca177a57940daa5817960373c6542', 'modified_at': '2025-03-26T10:18:04Z', 'modified_by': '4a816a3f5099442ebb52daefc1f7be32', 'modifier_email': '-', 'modifier_name': '-', 'name': 'openapi-ga2-testgroup5', 'policies': [], 'roles': [], 'srn': 'srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542', 'type': 'USER_DEFINED'}] | any of [array[Group], null] | |
| page required | page Example : 0 | integer | |
| policy_id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| roles optional | Role Example : [{'account_id': 'd7aba97100564b34a0f4f77c4bc7a303', 'assume_role_policy_document': {'Statement': [{'Action': '*', 'Condition': {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}, 'Effect': 'Allow', 'NotAction': '*', 'Principal': '*', 'Resource': '*', 'Sid': 'statement1'}], 'Version': '2024-07-01'}, 'created_at': '2024-05-17T00:23:17Z', 'created_by': 'ef50cdc207f05f6fb8f20219f229ed1f', 'creator_email': '-', 'creator_name': '-', 'description': 'string', 'id': 'f39c460fade34fecb05ede8f904b24b7', 'max_session_duration': 0, 'modified_at': '2024-05-17T00:23:17Z', 'modified_by': 'ef50cdc207f05f6fb8f20219f229ed1f', 'modifier_email': '-', 'modifier_name': '-', 'name': 'string', 'type': 'DEFAULT'}] | any of [array[Role], null] | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| users optional | User Example : [{'access_control': False, 'account_id': 'd7aba97100564b34a0f4f77c4bc7a303', 'account_name': '', 'allowed_ip_addresses': '', 'company_name': '', 'created_at': '2024-11-15T06:57:42.000000Z', 'created_by': '90dddfc2b1e04edba54ba2b41539a9ac', 'description': '', 'domain_name': 'scp', 'dst_offset': '+09:00', 'email': 'samsung.kim@samsung.com', 'email_authenticate_code': '8ada8861bad2423295e4bb576bee5886', 'email_authenticated': True, 'first_name': '', 'groups': [], 'id': '90dddfc2b1e04edba54ba2b41539a9ac', 'keycloak_id': '127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507', 'keystone_credential': '', 'last_login_at': '2024-11-25T06:57:42.000000Z', 'last_name': '', 'last_password_update_at': '', 'login_id': '', 'modified_at': '2024-11-17T06:57:42.000000Z', 'modified_by': '90dddfc2b1e04edba54ba2b41539a9ac', 'nation_id': '+82', 'phone_authenticated': False, 'phone_number': '0000000000', 'policies': [], 'state': 'ACTIVE', 'temporary_password': False, 'term_region_id': '1', 'timezone': 'Asia/Seoul', 'type': 'IAM', 'tz_id': 'Asia/Seoul', 'user_name': 'Kim Samsung', 'utc_offset': '+09:00'}] | any of [array[IAMUserResponseV1Dot4], null] |
48 - PolicyBindingSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| add_ids optional | ID List Example : ['a946662dc4314dac93da413a32457459'] | any of [array[string], null] | |
| identity_type required | Identity Type Example : GROUP | string | |
| remove_ids optional | ID List Example : ['a946662dc4314dac93da413a32457459'] | any of [array[string], null] |
49 - PolicyCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| default_version_id optional | Default Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | any of [string, null] | |
| description optional | Description Example : Descriptions for policy | any of [string, null] | |
| policy_category optional | Policy Category Example : IDENTITY_BASED | enum (IDENTITY_BASED, RESOURCE_BASED, SESSION) | IDENTITY_BASED |
| policy_name required | Policy Name Example : PolicyNamePattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 128 | string | |
| policy_type optional | Policy Type Example : USER_DEFINED | enum (SYSTEM_MANAGED, USER_DEFINED, INLINE) | USER_DEFINED |
| policy_version required | Policy Versions | PolicyVersionCreateRequest | |
| service_type optional | Service Type Example : scp-iam | any of [string, null] | |
| tags optional | Policy Tag Example : [{'key': 'foo', 'value': 'bar'}] | any of [array[object[string]], null] |
50 - PolicyDocument
| Name | Description | Schema | Default |
|---|---|---|---|
| Statement required | Statement | array[Statement] | |
| Version required | Policy Version Example : 2024-07-01 | string |
51 - PolicyPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies required | array[Policy] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
52 - PolicyQueryRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| excluded_policy_ids optional | Policy IDs to Exclude Example : ['37f2e31ff86b415698d7e8eeafab445d'] | any of [array[string], null] |
53 - PolicySetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| default_version_id optional | Default Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | any of [string, null] | |
| description optional | Description Example : Descriptions for policy | any of [string, null] | |
| policy_name optional | Policy Name Example : Policy1Pattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$ | any of [string, null] | |
| policy_version optional | Policy Versions | any of [PolicyVersionCreateRequest, null] |
54 - PolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account Id Example : e99c73a8690d4ae39ae75e38a26f2b99 | 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_email optional | Creator Email Example : samsung.kim@samsung.com | any of [string, null] | - |
| creator_name optional | Creator Last Name, First Name Example : Kim Samsung | any of [string, null] | |
| default_version_id optional | Default Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | string | |
| description optional | Description Example : Descriptions for policy | any of [string, null] | |
| domain_name required | Domain Name Example : scp | string | |
| id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_email optional | Modifier Email Example : samsung.kim@samsung.com | any of [string, null] | - |
| modifier_name optional | Modifier Last Name, First Name Example : Kim Samsung | any of [string, null] | |
| policy_category optional | Policy Category Example : IDENTITY_BASED | enum (IDENTITY_BASED, RESOURCE_BASED, SESSION) | |
| policy_name optional | Policy Name Example : PolicyNamePattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 128 | string | |
| policy_type optional | Policy Type Example : USER_DEFINED | enum (SYSTEM_MANAGED, USER_DEFINED, INLINE) | |
| policy_versions optional | Policy Versions | array[PolicyVersion] | |
| resource_type optional | Resource Type Example : policy | any of [string, null] | policy |
| service_name optional | Service Name Example : Identity Access Management | any of [string, null] | Identity Access Management |
| service_type optional | Service Type Example : iam | any of [string, null] | iam |
| srn required | Samsung Resource Name Example : srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d | string | |
| state optional | Policy State Example : ACTIVE | enum (ACTIVE, INACTIVE, DELETED) | ACTIVE |
55 - PolicyVersion
| 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 optional | Policy Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| policy_document required | Policy Document | IamPolicyDocument | |
| policy_id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| policy_version_name optional | Policy Version Name Example : PolicyVersion-1 | string |
56 - PolicyVersionCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_document required | Policy Document Example : {'Statement': [{'Action': ['iam:*'], 'Condition': {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}, 'Effect': 'Allow', 'Principal': None, 'Resource': ['*'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'} | IamPolicyDocument | |
| policy_id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| policy_version_id optional | Policy Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | string | |
| policy_version_name optional | Policy Version Name Example : PolicyVersion-1 | string | POLICY_VERSION_1 |
57 - ResourcePolicySetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_version required | Description | ResourcePolicyVersionCreateRequest |
58 - ResourcePolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account Id Example : e99c73a8690d4ae39ae75e38a26f2b99 | 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_email optional | Creator Email Example : samsung.kim@samsung.com | any of [string, null] | - |
| creator_name optional | Creator Last Name, First Name Example : Kim Samsung | any of [string, null] | |
| default_version_id optional | Default Version Id Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_email optional | Modifier Email Example : samsung.kim@samsung.com | any of [string, null] | - |
| modifier_name optional | Modifier Last Name, First Name Example : Kim Samsung | any of [string, null] | |
| policy_category optional | Policy Category Example : RESOURCE_BASED | enum (IDENTITY_BASED, RESOURCE_BASED, SESSION) | |
| policy_type optional | Policy Type Example : USER_DEFINED | enum (SYSTEM_MANAGED, USER_DEFINED, INLINE) | |
| policy_versions optional | Policy Versions | array[ResourcePolicyVersion] | |
| service_name optional | Service Name Example : Identity Access Management | any of [string, null] | Identity Access Management |
59 - ResourcePolicyVersion
| 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 optional | Policy Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| policy_document required | Policy Document Example : {'Statement': [{'Action': ['virtualserver:ShowVirtualServer'], 'Condition': {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'} | IamPolicyDocument |
60 - ResourcePolicyVersionCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_document required | Policy Document Example : {'Statement': [{'Action': ['virtualserver:ShowVirtualServer'], 'Condition': {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'} | IamPolicyDocument | |
| policy_id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | |
| policy_version_id optional | Policy Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | any of [string, null] | |
| policy_version_name optional | Policy Version Name Example : PolicyVersion-1 | string | POLICY_VERSION_1 |
61 - Role
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| assume_role_policy_document required | Role Trust Policy | PolicyDocument | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Creator Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| creator_email optional | Creator Email Example : | any of [string, null] | |
| creator_name optional | Creator Last Name, First Name Example : | any of [string, null] | |
| description optional | Role Description Example : | any of [string, null] | |
| id required | ID Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| max_session_duration required | Role Maximum Session Duration (seconds) Example : | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modifier Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| modifier_email optional | Modifier Email Example : | any of [string, null] | |
| modifier_name optional | Modifier Last Name, First Name Example : | any of [string, null] | |
| name required | Role Name Example : | string | |
| policies required | Policy List Attached to Role | any of [array[Policy], null] | |
| type optional | Role Type Example : USER_DEFINED | enum (USER_DEFINED, SERVICE, SERVICE_LINKED) | USER_DEFINED |
62 - RoleBulkDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| role_ids optional | Role ID List Example : | any of [array[string], null] | |
| role_names optional | Role Name List Example : | any of [array[string], null] |
63 - RoleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| assume_role_policy_document optional | Role Trust Policy Example : {'Statement': [{'Action': ['sts:AssumeRole'], 'Condition': {}, 'Effect': 'Allow', 'Principal': 'srn:e:1234:::iam:user/abc1234', 'Resource': [], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | any of [PolicyDocument, null] | |
| description optional | Role Description Example : | any of [string, null] | |
| max_session_duration optional | Role Maximum Session Duration (seconds) Example : 3600Minimum : 3600Maximum : 43200 | integer | 3600 |
| name required | Role Name Example : Pattern : ^[a-zA-Z0-9\+\=\,\.\@\-\_]*$Maximum length : 64 | string | |
| policy_ids required | Policy ID List to Attach to Role Example : ['37f2e31ff86b415698d7e8eeafab445d'] | array[string] | |
| principals optional | Trust Policy Principal List Example : [{'type': 'SRN', 'value': 'srn:e:1234:::iam:user/abc1234'}] | any of [array[RoleTrustPolicyPrincipal], null] | |
| tags optional | Role Tag Example : [{'key': 'company', 'value': 'SDS'}] | any of [array[object[string]], null] |
64 - RoleCreateRequestV1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| assume_role_policy_document optional | Role Trust Policy Example : {'Statement': [{'Action': ['sts:AssumeRole'], 'Condition': {}, 'Effect': 'Allow', 'Principal': 'srn:e:1234:::iam:user/abc1234', 'Resource': [], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | any of [PolicyDocument, null] | |
| description optional | Role Description Example : | any of [string, null] | |
| max_session_duration optional | Role Maximum Session Duration (seconds) Example : 3600Minimum : 3600Maximum : 43200 | integer | 3600 |
| name required | Role Name Example : Pattern : ^[a-zA-Z0-9\+\=\,\.\@\-\_]*$Maximum length : 64 | string | |
| policy_ids required | Policy ID List to Attach to Role Example : ['37f2e31ff86b415698d7e8eeafab445d'] | array[string] | |
| principals optional | Trust Policy Principal List Example : [{'type': 'SRN', 'value': 'srn:e:1234:::iam:user/abc1234'}] | any of [array[RoleTrustPolicyPrincipal], null] | |
| role_type optional | Role Type Example : USER_DEFINED | any of [string, null] | USER_DEFINED |
| tags optional | Role Tag Example : [{'key': 'company', 'value': 'SDS'}] | any of [array[object[string]], null] |
65 - RolePageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| roles required | array[Role] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
66 - RolePolicyBindingPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies required | array[Policy] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
67 - RolePolicyBindingRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_ids required | Policy ID List to Attach to Role | array[string] |
68 - RolePolicyBindingResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| policies required | array[Policy] |
69 - RoleSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Role Description Example : | any of [string, null] | |
| max_session_duration optional | Role Maximum Session Duration (seconds) Example : 3600 | any of [integer, null] |
70 - RoleShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| role required | Role |
71 - RoleTrustPolicyPrincipal
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | Trust Policy Principal Type Example : | string | |
| value required | Trust Policy Principal Example : | string |
72 - RoleTrustPolicyRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| assume_role_policy_document required | Role Trust Policy Example : {'Statement': [{'Action': ['sts:AssumeRole'], 'Condition': {}, 'Effect': 'Allow', 'Principal': 'srn:e:1234:::iam:user/abc1234', 'Resource': [], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | PolicyDocument |
73 - RoleTrustPolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| assume_role_policy_document required | PolicyDocument | ||
| 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 |
74 - SamlProviderCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Credential Provider Description Example : SAML provider Description | any of [string, null] | |
| federation_type required | Credential Provider Type Example : SAML | string | |
| file optional | Metadata File Example : keycloak-idp-saml.xml | string (binary) | |
| saml_provider_name required | Credential Provider Name Example : IdpTest | string | |
| tags optional | Tags Example : [{'key': 'company', 'value': 'SDS'}] | any of [array[object[string]], null] |
75 - SamlProviderCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| acs_url optional | ACS URL 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 optional | Creator Example : | any of [string, null] | |
| description optional | Credential Provider Description Example : | any of [string, null] | |
| federation_type optional | Credential Provider Type Example : | any of [string, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| idp_cert_end optional | Validity Period Example : | any of [string (date-time), null] | |
| idp_file_name optional | Metadata File Name Example : | any of [string, null] | |
| idp_file_size optional | Metadata File Size Example : | any of [integer, null] | |
| idp_issuer_url optional | Issuer URL Example : | any of [string, null] | |
| idp_sso_url optional | SSO Service Location Example : | 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 Example : | any of [string, null] | |
| saml_provider_name optional | Credential Provider Name Example : | any of [string, null] |
76 - SamlProviderDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| acs_url optional | ACS URL 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 optional | Creator Example : | any of [string, null] | |
| description optional | Credential Provider Description Example : | any of [string, null] | |
| federation_type optional | Credential Provider Type Example : | any of [string, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| idp_cert_end optional | Validity Period Example : | any of [string (date-time), null] | |
| idp_file_data optional | Metadata Content Example : | any of [string, null] | |
| idp_file_name optional | Metadata File Name Example : | any of [string, null] | |
| idp_file_size optional | Metadata File Size Example : | any of [integer, null] | |
| idp_issuer_url optional | Issuer URL Example : | any of [string, null] | |
| idp_sso_url optional | SSO Service Location Example : | 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 Example : | any of [string, null] | |
| saml_provider_name optional | Credential Provider Name Example : | any of [string, null] |
77 - SamlProviderResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| 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 Example : | any of [string, null] | |
| description optional | Credential Provider Description Example : | any of [string, null] | |
| federation_type optional | Credential Provider Type Example : | any of [string, null] | |
| 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 | |
| modifier_name optional | Modifier Example : | any of [string, null] | |
| saml_provider_name optional | Credential Provider Name Example : | any of [string, null] |
78 - SamlProviderUpdateRequestData
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Credential Provider Description Example : SAML provider Description | string | |
| file optional | Metadata File Example : keycloak-idp-saml.xml | string (binary) | |
| saml_provider_name optional | Credential Provider Name Example : IdpTest | any of [string, null] | |
| tags optional | Tags Example : [{'key': 'company', 'value': 'SDS'}] | any of [array[object[string]], null] |
79 - ServiceAccount
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Service Account ID Example : | string | |
| name required | Service Account Name Example : | string | |
| service required | Service Account’s Service Example : | string |
80 - ServiceAccountDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Service Account ID Example : | string | |
| name required | Service Account Name Example : | string | |
| password required | Service Account’s Password Example : | string | |
| service required | Service Account’s Service Example : | string |
81 - ServiceAccountListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| service_accounts required | array[ServiceAccount] |
82 - ServiceAccountShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| service_account required | ServiceAccountDetail |
83 - Statement
| Name | Description | Schema | Default |
|---|---|---|---|
| Action optional | Action Example : ['iam:*'] | any of [array[string], null] | |
| Condition optional | Condition Example : {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} | any of [object[object[array[object]]], null] | |
| Effect required | Effect Example : Allow | string | |
| NotAction optional | NotAction Example : | any of [array[string], null] | |
| Principal optional | Principal Example : | any of [string, object[array[string]], null] | |
| Resource optional | Resource Example : ['*'] | array[string] | |
| Sid optional | Statement Id Example : Statement1 | string | statement1 |
84 - StatementCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| Action optional | Action Example : ['virtualserver:ShowVirtualServer'] | any of [array[string], null] | |
| Condition optional | Condition Example : {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} | any of [object[object[array[object]]], null] | |
| Effect required | Effect Example : Allow | string | |
| NotAction optional | NotAction Example : | any of [array[string], null] | |
| Principal optional | Principal Example : * | any of [string, object[array[string]], null] | |
| Resource optional | Resource Example : ['srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666'] | array[string] | |
| Sid optional | Statement Id Example : Statement1 | string | statement1 |
85 - StatementResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| Statement required | Statement Example : {'Action': ['virtualserver:ShowVirtualServer'], 'Condition': {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666'], 'Sid': 'Statement1'} | Statement |
86 - UserPolicyPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies required | User Policy | array[Policy] | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| user_id required | User ID Example : | string |
87 - UserPolicyRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_ids optional | User Policy Bindings | array[string] |
88 - UserPolicyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| policies required | User Policy | array[Policy] | |
| user_id required | User ID Example : | string |
89 - UserResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| company_name optional | Company Name 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 | |
| description optional | User Description Example : | any of [string, null] | |
| dst_offset optional | DST Offset Example : | any of [string, null] | |
| email optional | User Email Example : | any of [string, null] | |
| email_authenticated required | Email Authentication Status Example : | boolean | |
| first_name optional | User Name Example : | any of [string, null] | |
| id required | ID Example : | string | |
| last_login_at optional | Last Login Example : | any of [string (date-time), null] | |
| last_name optional | User Last Name Example : | any of [string, null] | |
| last_password_update_at optional | Last Password Update Time Example : | any of [string (date-time), null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | Name Example : | any of [string, null] | |
| password_reuse_count required | Password Reuse Count Example : | integer | |
| phone_authenticated required | Phone Authentication Status Example : | boolean | |
| policies required | User Policies | any of [array[Policy], null] | |
| state optional | Status Example : | any of [string, null] | |
| timezone optional | Timezone ID Example : | any of [string, null] | |
| type required | Type Example : | string | |
| tz_id optional | Timezone ID Example : | any of [string, null] | |
| user_name optional | User Name Example : | any of [string, null] | |
| utc_offset optional | UTC Offset Example : | any of [string, null] |