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

Return to the regular view of this page.

Models

1 - AccessKey

NameDescriptionSchemaDefault
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
활성화 여부
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 which is used for temporary access key to create by
Example : 92d6eid9e9ae4f868s842910k11573a3
any of [string, null]
secret_key
required
Secret Key
Example : c4150149-f7c6-46bc-9faa-d2b9d20e0899
string

2 - AccessKeyCreateRequest

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

NameDescriptionSchemaDefault
locale
optional
Locale
Example : ko_KR
enum (ko_KR, en_US)
method
optional
OTP method (EMAIL or PHONE)
Example : PHONE
enum (PHONE, EMAIL)

4 - AccessKeyResponse

NameDescriptionSchemaDefault
access_key
required

AccessKey

5 - AccessKeyUpdateRequest

NameDescriptionSchemaDefault
is_enabled
optional
활성화 여부
Example : true
booleanTrue

6 - CreatedGroupMember

NameDescriptionSchemaDefault
created_at
required
생성 일시
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : ef50cdc207f05f6fb8f20219f229ed1f
string
creator_email
optional
생성자 Email
Example : samsung.kim@samsung.com
string-
creator_name
optional
생성자 성, 이름
Example : Kim Samsung
string-
user_email
optional
User Email
Example : samsung.kim@samsung.com
string-
user_id
required
User ID
Example : f39c460fade34fecb05ede8f904b24b7
string
user_name
optional
User 성, 이름
Example : Kim Samsung
string-

7 - EndpointsResponse

NameDescriptionSchemaDefault
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

8 - Group

NameDescriptionSchemaDefault
created_at
required
생성 일시
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : ef50cdc207f05f6fb8f20219f229ed1f
string
creator_email
optional
생성자 Email
Example : samsung.kim@samsung.com
string-
creator_name
optional
생성자 성, 이름
Example : Kim Samsung
string-
description
required
Group 설명
Example : Descriptions for group
any of [string, null]
domain_name
required
도메인 이름
Example : scp
string
id
required
ID
Example : f39c460fade34fecb05ede8f904b24b7
string
members
optional
Project Group Member List
any of [array[GroupMember], null]
modified_at
required
수정 일시
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : ef50cdc207f05f6fb8f20219f229ed1f
string
modifier_email
optional
수정자 Email
Example : samsung.kim@samsung.com
string-
modifier_name
optional
수정자 성, 이름
Example : Kim Samsung
string-
name
required
Group 이름
Example : TestGroup
Pattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$
Minimum length : 3
Maximum length : 24
string
policies
required
Policy
any of [array[Policy], null]
resource_type
optional
리소스 명
Example : group
any of [string, null]group
roles
required
Role 정보
any of [array[Role], null]
service_name
optional
서비스 Display 명
Example : Identity Access Management
any of [string, null]Identity Access Management
service_type
optional
서비스 명
Example : iam
any of [string, null]iam
srn
optional
Group SRN
Example : srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
any of [string, null]
type
required
Group Type
Example : USER_DEFINED
string

9 - GroupCreateRequest

NameDescriptionSchemaDefault
description
required
Group 설명
Example : Descriptions for group
any of [string, null]
name
required
Group 이름
Example : TestGroup
Pattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$
Minimum length : 3
Maximum 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]

10 - GroupMember

NameDescriptionSchemaDefault
created_at
required
생성 일시
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : ef50cdc207f05f6fb8f20219f229ed1f
string
creator_created_at
required
생성 일시
Example : 2024-05-17T00:23:17Z
string (date-time)
creator_email
optional
생성자 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
생성자 성, 이름
Example : Kim Samsung
string-
group_names
optional
Group names
Example : ['TestGroup', 'SampleGroup']
array[string]
user_created_at
required
생성 일시
Example : 2024-05-17T00:23:17Z
string (date-time)
user_email
optional
User 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
User 성, 이름
Example : Kim Samsung
string-

11 - GroupMemberCreateRequest

NameDescriptionSchemaDefault
user_id
required
Group Member User ID
Example : f39c460fade34fecb05ede8f904b24b7
string

12 - GroupMemberCreateResponse

NameDescriptionSchemaDefault
group_member
required

CreatedGroupMember

13 - GroupMemberPageResponse

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

14 - GroupPageResponse

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

15 - GroupPolicyBindingRequest

NameDescriptionSchemaDefault
policy_ids
required
Policy ID List
Example : ['37f2e31ff86b415698d7e8eeafab445d']
array[string]

16 - GroupPolicyPageResponse

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

17 - GroupPolicyResponse

NameDescriptionSchemaDefault
policies
required

array[Policy]

18 - GroupSetRequest

NameDescriptionSchemaDefault
description
required
Group 설명
Example : Descriptions for group
any of [string, null]
name
required
Group 이름
Example : TestGroup
Pattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$
Minimum length : 3
Maximum length : 24
string

19 - GroupShowResponse

NameDescriptionSchemaDefault
group
required

Group

20 - IAMCreateUserResponse

NameDescriptionSchemaDefault
account_id
optional
Account ID
Example :
any of [string, null]
company_name
optional
회사 이름
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 인증 여부
Example :
boolean
first_name
optional
사용자 이름
Example :
any of [string, null]
id
required
ID
Example :
string
last_login_at
optional
마지막 로그인
Example :
any of [string (date-time), null]
last_name
optional
사용자 성
Example :
any of [string, null]
last_password_update_at
optional
마지막 비밀번호 수정시간
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
비밀 번호
Example :
string
password_reuse_count
required
비밀 번호 재사용 가능 횟수
Example :
integer
phone_authenticated
required
휴대폰 인증 여부
Example :
boolean
policies
required
User Policies
any of [array[Policy], null]
state
optional
상태
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]

21 - IamPolicyDocument

NameDescriptionSchemaDefault
Statement
required
Statement
array[Statement]
Version
required
Policy Version
Example : 2024-07-01
string

22 - IAMUserCreateRequest

NameDescriptionSchemaDefault
description
optional
description
Example :
any of [string, null]
group_ids
optional
Group IDs
Example :
any of [array[string], null]
password
required
비밀 번호
Example :
string
policy_ids
optional
Policy IDs
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
사용자 이름
Example :
Pattern : ^[a-zA-Z0-9\+\.\@\-\_]*$
Maximum length : 64
string

23 - IAMUserDeleteRequest

NameDescriptionSchemaDefault
user_ids
optional
사용자 ID 목록
Example :
any of [array[string], null]

24 - IAMUserDetailResponse

NameDescriptionSchemaDefault
account_id
optional
Account ID
Example :
any of [string, null]
company_name
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
created_by_name
optional
created_by_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 인증 여부
Example :
boolean
first_name
optional
사용자 이름
Example :
any of [string, null]
id
required
ID
Example :
string
last_login_at
optional
마지막 로그인
Example :
any of [string (date-time), null]
last_name
optional
사용자 성
Example :
any of [string, null]
last_password_update_at
optional
마지막 비밀번호 수정시간
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
modified_by_name
Example :
any of [string, null]
name
optional
Name
Example :
any of [string, null]
password_reuse_count
required
비밀 번호 재사용 가능 횟수
Example :
integer
phone_authenticated
required
휴대폰 인증 여부
Example :
boolean
policies
required
User Policies
any of [array[Policy], null]
resource_type
optional
service
Example : User
any of [string, null]User
service
optional
서비스 명
Example : iam
any of [string, null]iam
service_name
optional
서비스 Display 명
Example : Identity Access Management
any of [string, null]Identity Access Management
srn
required
SRN
Example :
any of [string, null]
state
optional
상태
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 - IAMUserPasswordUpdateRequest

NameDescriptionSchemaDefault
password
required
비밀 번호
Example :
string
temporary_password
optional
temporary
Example : False
any of [boolean, null]

26 - IAMUserResponse

NameDescriptionSchemaDefault
account_id
optional
Account ID
Example :
any of [string, null]
company_name
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
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 인증 여부
Example :
boolean
first_name
optional
사용자 이름
Example :
any of [string, null]
groups
optional
group names
Example :
any of [array[string], null]
id
required
ID
Example :
string
last_login_at
optional
마지막 로그인
Example :
any of [string (date-time), null]
last_name
optional
사용자 성
Example :
any of [string, null]
last_password_update_at
optional
마지막 비밀번호 수정시간
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
비밀 번호 재사용 가능 횟수
Example :
integer
phone_authenticated
required
휴대폰 인증 여부
Example :
boolean
policies
required
User Policies
any of [array[Policy], null]
state
optional
상태
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]

27 - IAMUserUpdateRequest

NameDescriptionSchemaDefault
description
optional
description
Example :
any of [string, null]
password_reuse_count
required
비밀 번호 재사용 가능 횟수
Example :
Maximum : 24
integer

28 - ListAccessKeyRemoveRequest

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

29 - ListAccessKeyResponse

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

30 - ListEndpointsResponse

NameDescriptionSchemaDefault
endpoints
required

array[EndpointsResponse]

31 - ListIAMUserResponse

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[IAMUserResponse]

32 - ListPolicyRemoveRequest

NameDescriptionSchemaDefault
ids
optional
Policy id list
Example : ['37f2e31ff86b415698d7e8eeafab445d']
array[string]

33 - ListSamlProviderRemoveRequest

NameDescriptionSchemaDefault
ids
optional
Saml provider id list
array[string]

34 - ListSamlProviderResponse

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

35 - Policy

NameDescriptionSchemaDefault
account_id
required
Project 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
생성자 Email
Example : samsung.kim@samsung.com
any of [string, null]
creator_name
optional
생성자 성, 이름
Example : Kim Samsung
any of [string, null]
default_version_id
optional
Policy Default Version Id
Example : c1b1fc611eb34eccbccfb563f77395ee
string
description
optional
Description
Example : Descriptions for policy
any of [string, null]
domain_name
required
도메인 이름
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
수정자 Email
Example : samsung.kim@samsung.com
any of [string, null]
modifier_name
optional
수정자 성, 이름
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 : PolicyName
Pattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$
Minimum length : 3
Maximum 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
서비스 Display 명
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
삼성 리소스 자원명
Example : srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
string
state
optional
Policy State
Example : ACTIVE
enum (ACTIVE, INACTIVE, DELETED)ACTIVE

36 - PolicyBindingPageResponse

NameDescriptionSchemaDefault
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[object], 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[object], 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[object], null]

37 - PolicyBindingSetRequest

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

38 - PolicyCreateRequest

NameDescriptionSchemaDefault
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 : PolicyName
Pattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$
Minimum length : 3
Maximum length : 128
string
policy_type
optional
Policy Type
Example : USER_DEFINED
enum (SYSTEM_MANAGED, USER_DEFINED, INLINE)USER_DEFINED
policy_version
required
Policy Version
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]

39 - PolicyDocument

NameDescriptionSchemaDefault
Statement
required
Statement
array[Statement]
Version
required
Policy Version
Example : 2024-07-01
string

40 - PolicyPageResponse

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

41 - PolicyQueryRequest

NameDescriptionSchemaDefault
excluded_policy_ids
optional
제외할 Policy IDs
Example : ['37f2e31ff86b415698d7e8eeafab445d']
any of [array[string], null]

42 - PolicySetRequest

NameDescriptionSchemaDefault
default_version_id
optional
Policy 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 : Policy1
Pattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$
any of [string, null]
policy_version
optional
Policy Versions
any of [PolicyVersionCreateRequest, null]

43 - PolicyShowResponse

NameDescriptionSchemaDefault
account_id
required
Project 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
생성자 Email
Example : samsung.kim@samsung.com
any of [string, null]
creator_name
optional
생성자 성, 이름
Example : Kim Samsung
any of [string, null]
default_version_id
optional
Policy Default Version Id
Example : c1b1fc611eb34eccbccfb563f77395ee
string
description
optional
Description
Example : Descriptions for policy
any of [string, null]
domain_name
required
도메인 이름
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
수정자 Email
Example : samsung.kim@samsung.com
any of [string, null]
modifier_name
optional
수정자 성, 이름
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 : PolicyName
Pattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$
Minimum length : 3
Maximum 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
서비스 Display 명
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
삼성 리소스 자원명
Example : srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
string
state
optional
Policy State
Example : ACTIVE
enum (ACTIVE, INACTIVE, DELETED)ACTIVE

44 - PolicyVersion

NameDescriptionSchemaDefault
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

45 - PolicyVersionCreateRequest

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

46 - ResourcePolicySetRequest

NameDescriptionSchemaDefault
policy_version
required
Description
ResourcePolicyVersionCreateRequest

47 - ResourcePolicyShowResponse

NameDescriptionSchemaDefault
account_id
required
Project 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
생성자 Email
Example : samsung.kim@samsung.com
any of [string, null]
creator_name
optional
생성자 성, 이름
Example : Kim Samsung
any of [string, null]
default_version_id
optional
Policy 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
수정자 Email
Example : samsung.kim@samsung.com
any of [string, null]
modifier_name
optional
수정자 성, 이름
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
서비스 Display 명
Example : Identity Access Management
any of [string, null]Identity Access Management

48 - ResourcePolicyVersion

NameDescriptionSchemaDefault
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

49 - ResourcePolicyVersionCreateRequest

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

50 - Role

NameDescriptionSchemaDefault
account_id
optional
역할이 속한 계정의 ID
Example :
any of [string, null]
assume_role_policy_document
required
역할 신뢰 정책
PolicyDocument
created_at
required
생성 일시
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : ef50cdc207f05f6fb8f20219f229ed1f
string
creator_email
optional
생성자 Email
Example :
any of [string, null]
creator_name
optional
생성자 성, 이름
Example :
any of [string, null]
description
required
역할 설명
Example :
any of [string, null]
id
required
ID
Example : f39c460fade34fecb05ede8f904b24b7
string
max_session_duration
required
역할 세션 최대 지속 시간(초)
Example :
integer
modified_at
required
수정 일시
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : ef50cdc207f05f6fb8f20219f229ed1f
string
modifier_email
optional
수정자 Email
Example :
any of [string, null]
modifier_name
optional
수정자 성, 이름
Example :
any of [string, null]
name
required
역할명
Example :
string
policies
required
역할에 연결된 정책 목록
any of [array[Policy], null]
type
optional
역할 유형
Example : USER_DEFINED
enum (USER_DEFINED, SERVICE, SERVICE_LINKED)USER_DEFINED

51 - RoleBulkDeleteRequest

NameDescriptionSchemaDefault
account_id
optional
역할이 속한 계정의 ID
Example :
any of [string, null]
role_ids
optional
역할 ID 목록
Example :
any of [array[string], null]
role_names
optional
역할명 목록
Example :
any of [array[string], null]

52 - RoleCreateRequest

NameDescriptionSchemaDefault
account_id
optional
역할이 속한 계정의 ID
Example :
any of [string, null]
assume_role_policy_document
optional
역할 신뢰 정책
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
역할 설명
Example :
any of [string, null]
max_session_duration
optional
역할 세션 최대 지속 시간(초)
Example : 3600
Minimum : 3600
Maximum : 43200
integer3600
name
required
역할명
Example :
Pattern : ^[a-zA-Z0-9\+\=\,\.\@\-\_]*$
Maximum length : 64
string
policy_ids
required
역할에 연결할 정책 ID 목록
Example : ['37f2e31ff86b415698d7e8eeafab445d']
array[string]
principals
optional
신뢰 정책 수행 주체 목록
Example : [{'type': 'SRN', 'value': 'srn:e:1234:::iam:user/abc1234'}]
any of [array[RoleTrustPolicyPrincipal], null]
tags
optional
역할 태그
Example : [{'key': 'company', 'value': 'SDS'}]
any of [array[object[string]], null]

53 - RolePageResponse

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

54 - RolePolicyBindingPageResponse

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

55 - RolePolicyBindingRequest

NameDescriptionSchemaDefault
policy_ids
required
Policy ID List
array[string]

56 - RolePolicyBindingResponse

NameDescriptionSchemaDefault
policies
required

array[Policy]

57 - RoleSetRequest

NameDescriptionSchemaDefault
description
optional
역할 설명
Example :
any of [string, null]
max_session_duration
optional
역할 세션 최대 지속 시간(초)
Example : 3600
any of [integer, null]

58 - RoleShowResponse

NameDescriptionSchemaDefault
role
required

Role

59 - RoleTrustPolicyPrincipal

NameDescriptionSchemaDefault
type
required
신뢰 정책 수행 주체 유형
Example :
string
value
required
신뢰 정책 수행 주체
Example :
string

60 - RoleTrustPolicyRequest

NameDescriptionSchemaDefault
assume_role_policy_document
required
역할 신뢰 정책
Example : {'Statement': [{'Action': ['sts:AssumeRole'], 'Condition': {}, 'Effect': 'Allow', 'Principal': 'srn:e:1234:::iam:user/abc1234', 'Resource': [], 'Sid': 'statement1'}], 'Version': '2024-07-01'}
PolicyDocument

61 - RoleTrustPolicyShowResponse

NameDescriptionSchemaDefault
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

62 - SamlProviderCreateRequest

NameDescriptionSchemaDefault
description
optional
자격증명공급자 설명
Example : SAML provider Description
any of [string, null]
federation_type
required
자격증명공급자 유형
Example : SAML
string
file
optional
메타데이터 파일
Example : keycloak-idp-saml.xml
string (binary)
saml_provider_name
required
자격증명공급자 이름
Example : IdpTest
string
tags
optional
태그
Example : [{'key': 'company', 'value': 'SDS'}]
any of [array[object[string]], null]

63 - SamlProviderCreateResponse

NameDescriptionSchemaDefault
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
생성자
Example :
any of [string, null]
description
optional
자격증명공급자 설명
Example :
any of [string, null]
federation_type
optional
자격증명공급자 유형
Example :
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
idp_cert_end
optional
유효기간
Example :
any of [string (date-time), null]
idp_file_name
optional
메타데이터 파일 이름
Example :
any of [string, null]
idp_file_size
optional
메타데이터 파일 크기
Example :
any of [integer, null]
idp_issuer_url
optional
발행자 URL
Example :
any of [string, null]
idp_sso_url
optional
SSO 서비스 위치
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
수정자
Example :
any of [string, null]
saml_provider_name
optional
자격증명공급자 이름
Example :
any of [string, null]

64 - SamlProviderDetailResponse

NameDescriptionSchemaDefault
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
생성자
Example :
any of [string, null]
description
optional
자격증명공급자 설명
Example :
any of [string, null]
federation_type
optional
자격증명공급자 유형
Example :
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
idp_cert_end
optional
유효기간
Example :
any of [string (date-time), null]
idp_file_data
optional
메타데이터 내용
Example :
any of [string, null]
idp_file_name
optional
메타데이터 파일 이름
Example :
any of [string, null]
idp_file_size
optional
메타데이터 파일 크기
Example :
any of [integer, null]
idp_issuer_url
optional
발행자 URL
Example :
any of [string, null]
idp_sso_url
optional
SSO 서비스 위치
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
수정자
Example :
any of [string, null]
saml_provider_name
optional
자격증명공급자 이름
Example :
any of [string, null]

65 - SamlProviderResponse

NameDescriptionSchemaDefault
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
생성자
Example :
any of [string, null]
description
optional
자격증명공급자 설명
Example :
any of [string, null]
federation_type
optional
자격증명공급자 유형
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
수정자
Example :
any of [string, null]
saml_provider_name
optional
자격증명공급자 이름
Example :
any of [string, null]

66 - SamlProviderUpdateRequestData

NameDescriptionSchemaDefault
description
optional
자격증명공급자 설명
Example : SAML provider Description
string
file
optional
메타데이터 파일
Example : keycloak-idp-saml.xml
string (binary)
saml_provider_name
optional
자격증명공급자 이름
Example : IdpTest
any of [string, null]
tags
optional
태그
Example : [{'key': 'company', 'value': 'SDS'}]
any of [array[object[string]], null]

67 - ServiceAccount

NameDescriptionSchemaDefault
id
required
Service Account ID
Example :
string
name
required
Service Account Name
Example :
string
service
required
Service Account’s Service
Example :
string

68 - ServiceAccountDetail

NameDescriptionSchemaDefault
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

69 - ServiceAccountListResponse

NameDescriptionSchemaDefault
service_accounts
required

array[ServiceAccount]

70 - ServiceAccountShowResponse

NameDescriptionSchemaDefault
service_account
required

ServiceAccountDetail

71 - Statement

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

72 - StatementCreateRequest

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

73 - StatementResponse

NameDescriptionSchemaDefault
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

74 - UserPolicyPageResponse

NameDescriptionSchemaDefault
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
사용자 ID
Example :
string

75 - UserPolicyRequest

NameDescriptionSchemaDefault
policy_ids
optional
User Policy Bindings
array[string]

76 - UserPolicyResponse

NameDescriptionSchemaDefault
policies
required
User policy
array[Policy]
user_id
required
사용자 ID
Example :
string

77 - UserResponse

NameDescriptionSchemaDefault
account_id
optional
Account ID
Example :
any of [string, null]
company_name
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
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 인증 여부
Example :
boolean
first_name
optional
사용자 이름
Example :
any of [string, null]
id
required
ID
Example :
string
last_login_at
optional
마지막 로그인
Example :
any of [string (date-time), null]
last_name
optional
사용자 성
Example :
any of [string, null]
last_password_update_at
optional
마지막 비밀번호 수정시간
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
비밀 번호 재사용 가능 횟수
Example :
integer
phone_authenticated
required
휴대폰 인증 여부
Example :
boolean
policies
required
User Policies
any of [array[Policy], null]
state
optional
상태
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]