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

Return to the regular view of this page.

Models

1: AccountFactoryCreateRequest
2: AccountFactoryCreateResponse
3: AccountsForGuardrail
4: BaselineAssignment
5: BaselineAssignmentAddRequest
6: BaselineAssignmentAddResponse
7: BaselineAssignmentListResponse
8: BaselineAssignmentListResponseV1Dot1
9: BaselineAssignmentRemoveRequest
10: BaselineAssignmentRemoveResponse
11: BaselineAssignmentUpdateRequest
12: BaselineAssignmentV1Dot1
13: Guardrail
14: GuardrailAssignmentDetail
15: GuardrailAssignmentFailCaused
16: GuardrailAssignmentResponse
17: GuardrailBindingOu
18: GuardrailDisableRequest
19: GuardrailEnableRequest
20: GuardrailLinkInfo
21: GuardrailPageResponse
22: GuardrailsForTargetSummary
23: GuardrailShowResponse
24: GuardrailSummary
25: LandingZone
26: LandingZoneCreateRequest
27: LandingZoneCreateRequestV1Dot1
28: LandingZoneCreateResponse
29: LandingZoneShowResponse
30: LandingZoneShowResponseV1Dot1
31: LandingZoneUpdateRequest
32: LandingZoneV1Dot1
33: ListGuardrailsForTargetResponse
34: ListTargetsForGuardrailResponse
35: OrganizationUnitsForGuardrail

1 - AccountFactoryCreateRequest

Name	Description	Schema
email optional	Account Email Example : `myaccount@example.com`	any of [string, null]
landing_zone_id required	Landing Zone ID Example : `2c8a138f8d78e1fc29a449dbfa8681`	string
name required	Account Name Example : `foo-account`	string
parent_unit_id required	Parent Organization Unit ID Example : `ou-b30e9fcc39f84a20bf9e7458e5ec3801`	string
sso_user_email optional	ID Center User Email Example : `user_email@example.com`	any of [string, null]
sso_user_name optional	ID Center User Name Example : `John Doe`	any of [string, null]
sso_user_real_name optional	ID Center User Real Name Example : `John Doe`	any of [string, null]

2 - AccountFactoryCreateResponse

Name	Description	Schema	Default
account_id required	Organization Account ID Example : `b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0`	string
job_id required	ID Example : `0a36e0746dbf4908acf0357829701381`	string

3 - AccountsForGuardrail

Name	Description	Schema
email optional	Account Email Example : `score@samsung.com`	any of [string, null]
id required	Organization Account ID Example : `b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0`	string
name optional	Account Name Example : `score-account`	any of [string, null]
parent_unit_id required	Root or Parent Organization Unit ID Example : `ou-fc8c29a138d78e24bf1fa86812fc8b`	string
parent_unit_name required	Root or Parent Organization Unit Name Example : `parent-unit-name`	string

4 - BaselineAssignment

Name	Description	Schema
account_assigned_count optional	Registered Account Count Example : `3`	any of [integer, null]
account_count optional	Total Account Count Example : `4`	any of [integer, null]
id required	Root/Organization Unit/Account ID Example : `ou-b30e9fcc39f84a20bf9e7458e5ec3801`	string
ou_assigned_count optional	Registered Organization Unit Count Example : `5`	any of [integer, null]
ou_count optional	Total Organization Unit Count Example : `10`	any of [integer, null]
preventive_guardrail_activated_count optional	Activated Preventive Guardrail Count Example : `8`	any of [integer, null]
sso_user_name optional	ID Center User Name Example : `testuser`	any of [string, null]
status optional	State Example : `REGISTERED`	any of [string, null]
type required	OU/Account Example : `OU`	string

5 - BaselineAssignmentAddRequest

Name	Description	Schema
agree_yn optional	Terms Agreement YN Example : `Y`	any of [enum (Y, N), null]
landing_zone_id required	Landing Zone ID Example : `2c8a138f8d78e1fc29a449dbfa8681`	string
parent_unit_id optional	Root or Parent Organization Unit ID Example : `ou-fc8c29a138d78e24bf1fa86812fc8b`	any of [string, null]
resource_type required	OU/Account Example : `OU`	enum (ACCOUNT, OU)
sso_user_name optional	ID Center User Name Example : `testuser`	any of [string, null]
sso_user_real_name optional	ID Center User Real Name Example : `test user`	any of [string, null]

6 - BaselineAssignmentAddResponse

Name	Description	Schema
job_id required	ID Example : `0a36e0746dbf4908acf0357829701381`	string
resource_id required	Root/Organization Unit/Account ID Example : `ou-b30e9fcc39f84a20bf9e7458e5ec3801`	string
resource_type required	OU/Account Example : `OU`	string

7 - BaselineAssignmentListResponse

Name	Description	Schema	Default
baseline_assignments required		array[BaselineAssignment]

8 - BaselineAssignmentListResponseV1Dot1

Name	Description	Schema	Default
baseline_assignments required		array[BaselineAssignmentV1Dot1]

9 - BaselineAssignmentRemoveRequest

Name	Description	Schema	Default
landing_zone_id required	Landing Zone ID Example : `2c8a138f8d78e1fc29a449dbfa8681`	string
resource_type required	OU/Account Example : `ACCOUNT`	enum (ACCOUNT, OU)

10 - BaselineAssignmentRemoveResponse

Name	Description	Schema
job_id required	ID Example : `0a36e0746dbf4908acf0357829701381`	string
resource_id required	Root/Organization Unit/Account ID Example : `ou-b30e9fcc39f84a20bf9e7458e5ec3801`	string
resource_type required	OU/Account Example : `ACCOUNT`	string

11 - BaselineAssignmentUpdateRequest

Name	Description	Schema	Default
agree_yn optional	Terms Agreement YN Example : `Y`	any of [enum (Y, N), null]
landing_zone_id required	Landing Zone ID Example : `2c8a138f8d78e1fc29a449dbfa8681`	string

12 - BaselineAssignmentV1Dot1

Name	Description	Schema
account_assigned_count optional	Registered Account Count Example : `3`	any of [integer, null]
account_count optional	Total Account Count Example : `4`	any of [integer, null]
detective_guardrail_status optional	Detective Guardrail Status Example : `ENABLED`	any of [string, null]
detective_guardrail_type optional	Detective Guardrail Type Example : `SSI`	any of [string, null]
id required	Root/Organization Unit/Account ID Example : `ou-b30e9fcc39f84a20bf9e7458e5ec3801`	string
ou_assigned_count optional	Registered Organization Unit Count Example : `5`	any of [integer, null]
ou_count optional	Total Organization Unit Count Example : `10`	any of [integer, null]
preventive_guardrail_activated_count optional	Activated Preventive Guardrail Count Example : `8`	any of [integer, null]
sso_user_name optional	ID Center User Name Example : `testuser`	any of [string, null]
status optional	State Example : `REGISTERED`	any of [string, null]
type required	OU/Account Example : `OU`	string

13 - Guardrail

Name	Description	Schema	Default
binding_ous optional		any of [array[GuardrailBindingOu], array[object], null]
created_at required	Created At Example : `2025-01-01T00:00:00.000Z`	string (date-time)
created_by required	Created By Example : `c23fb561c689455993874fa5d5ed4a2f`	string
description optional	Guardrail Description Example : `This is an example guardrail.`	any of [string, null]
guidance required	Policy Guidance Example : `MANDATORY`	string
id required	Guardrail ID Example : `2c8a138f8d78e1fc29a449dbfa8681`	string
modified_at required	Modified At Example : `2025-01-01T00:00:00.000Z`	string (date-time)
modified_by required	Modified By Example : `c23fb561c689455993874fa5d5ed4a2f`	string
name required	Guardrail Name Example : `foo-guardrail`	string
service_name required	Organization Example : `iam`	string
srn optional	Guardrail SRN Example : `srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681`	any of [string, null]
status optional	Application Status Example : `DISABLED`	string	DISABLED
type required	Guardrail Type Example : `PREVENTIVE`	string

14 - GuardrailAssignmentDetail

Name	Description	Schema	Default
guardrail_id required	Guardrail ID Example : `f98e76d54c32b10a9z8y7x6w5v4u3`	string
unit_id required	Target ID Example : `ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5`	string

15 - GuardrailAssignmentFailCaused

Name	Description	Schema
error_code required	Error Code Example : `CloudControl.AlreadyEnabledGuardrails`	string
failed_caused required	Failure Cause Example : `guardrail already enabled`	string
guardrail_id required	Guardrail ID Example : `f98e76d54c32b10a9z8y7x6w5v4u3`	string
response optional	Example :	any of [object, null]
unit_id required	Target ID Example : `ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5`	string

16 - GuardrailAssignmentResponse

Name	Description	Schema	Default
failed_ids required		array[GuardrailAssignmentFailCaused]
success_ids required	Success ID	array[GuardrailAssignmentDetail]

17 - GuardrailBindingOu

Name	Description	Schema	Default
id required	Organization Unit ID Example : `ou-c29a138f8f1d78e24dbfa8681fc2fc8`	string
name required	Organization Unit Name Example : `score-organization-unit`	string

18 - GuardrailDisableRequest

Name	Description	Schema
guardrail_ids required	Guardrail List ID Example : `['f98e76d54c32b10a9z8y7x6w5v4u3']`	array[string]
landing_zone_id optional	Landing Zone ID Example : `2c8a138f8d78e1fc29a449dbfa8681`	any of [string, null]
unit_ids required	Target Info Example : `['ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5']`	array[string]

19 - GuardrailEnableRequest

Name	Description	Schema
guardrail_ids required	Guardrail List ID Example : `['f98e76d54c32b10a9z8y7x6w5v4u3']`	array[string]
landing_zone_id optional	Landing Zone ID Example : `2c8a138f8d78e1fc29a449dbfa8681`	any of [string, null]
unit_ids required	Target Info Example : `['ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5']`	array[string]

20 - GuardrailLinkInfo

Name	Description	Schema	Default
target_id required	Target ID Example : `ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5`	string
target_name required	Target Name Example : `ou-test`	any of [string, null]

21 - GuardrailPageResponse

Name	Description	Schema
count required	count Example : `20`	integer
guardrails required		array[GuardrailSummary]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

22 - GuardrailsForTargetSummary

Name	Description	Schema
created_at required	Created At Example : `2025-01-01T00:00:00.000Z`	string (date-time)
created_by required	Created By Example : `c23fb561c689455993874fa5d5ed4a2f`	string
guidance required	Policy Guidance Example : `MANDATORY`	string
id required	ID Example : `0a36e0746dbf4908acf0357829701381`	string
link_types required	Link Type Example : `{'directed': [{'target_id': '1a2b3c4d5e6f7g8h9i0j1k2l3m4n5', 'target_name': 'example-target'}], 'inherited': [{'target_id': '2a2b3c4d5e6f7g8h9i0j1k2l3m4n5', 'target_name': 'root'}]}`	object[array[GuardrailLinkInfo]]
modified_at required	Modified At Example : `2025-01-01T00:00:00.000Z`	string (date-time)
modified_by required	Modified By Example : `c23fb561c689455993874fa5d5ed4a2f`	string
name required	Guardrail Name Example : `foo-guardrail`	string
service_name required	Organization Example : `iam`	string
type required	Guardrail Type Example : `PREVENTIVE`	string

23 - GuardrailShowResponse

Name	Description	Schema	Default
guardrail required		Guardrail

24 - GuardrailSummary

Name	Description	Schema	Default
binding_ous optional		any of [array[GuardrailBindingOu], array[object], null]
created_at required	Created At Example : `2025-01-01T00:00:00.000Z`	string (date-time)
created_by required	Created By Example : `c23fb561c689455993874fa5d5ed4a2f`	string
description optional	Guardrail Description Example : `This is an example guardrail.`	any of [string, null]
guidance required	Policy Guidance Example : `MANDATORY`	string
id required	Guardrail ID Example : `2c8a138f8d78e1fc29a449dbfa8681`	string
modified_at required	Modified At Example : `2025-01-01T00:00:00.000Z`	string (date-time)
modified_by required	Modified By Example : `c23fb561c689455993874fa5d5ed4a2f`	string
name required	Guardrail Name Example : `foo-guardrail`	string
service_name required	Organization Example : `iam`	string
srn optional	Guardrail SRN Example : `srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681`	any of [string, null]
status optional	Application Status Example : `DISABLED`	string	DISABLED
type required	Guardrail Type Example : `PREVENTIVE`	string

25 - LandingZone

Name	Description	Schema	Default
agree_yn required	Terms Agreement YN Example : `Y`	string
created_at required	Created At Example : `2025-01-01T00:00:00.000Z`	string (date-time)
created_by required	Created By Example : `c23fb561c689455993874fa5d5ed4a2f`	string
creator_name optional	Creator Name Example : `John Doe na`	string	-
id required	Landing Zone ID Example : `2c8a138f8d78e1fc29a449dbfa8681`	string
identity_center_id optional	Identity Center ID Example : `0xnw6g1xh2q5`	any of [string, null]
modified_at required	Modified At Example : `2025-01-01T00:00:00.000Z`	string (date-time)
modified_by required	Modified By Example : `c23fb561c689455993874fa5d5ed4a2f`	string
modifier_name optional	Modifier Name Example : `Alice`	string	-
organization_id required	Organization ID Example : `o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5`	string
region required	Region Example : `kr-west1`	string
service_name required	Service Name Example : `Cloud Control`	string
srn required	Landing Zone SRN Example : `srn:dev2::a8a2f3c2659646ecaaf28fc8f783921a:::cloudcontrol:landingzone/f7a1ef0b17e34a37811cc2fa7a6bd50b`	string
sso_type required	Account Access Configuration Example : `ID_CENTER`	string
status required	State Example : `ACTIVE`	string
version_id required	Landing Zone Version Example : `1.0`	string

26 - LandingZoneCreateRequest

Name	Description	Schema
additional_ou_name required	Additional Organization Unit Name Example : `Sandbox` Minimum length : `1` Maximum length : `128`	string
agree_yn required	Terms Agreement YN Example : `Y`	enum (Y, N)
audit_account_name required	Audit Account Name Example : `AUDIT` Pattern : `^[a-zA-Z0-9ㄱ-ㅎㅏ-ㅣ가-힣 \+=_\-@\[\]\.,]$` Minimum length* : `3` Maximum length : `30`	string
audit_login_id required	Login ID Example : `audit@samsung.com` Maximum length : `60`	string (email)
basic_ou_name required	Basic Organization Unit Name Example : `Security` Minimum length : `1` Maximum length : `128`	string
log_archive_account_name required	Log Archive Account Name Example : `LOG_ARCHIVE` Pattern : `^[a-zA-Z0-9ㄱ-ㅎㅏ-ㅣ가-힣 \+=_\-@\[\]\.,]$` Minimum length* : `3` Maximum length : `30`	string
log_archive_login_id required	Login ID Example : `log-archive@samsung.com` Maximum length : `60`	string (email)
sso_type required	Account Access Configuration Example : `ID_CENTER`	enum (ID_CENTER, SELF)

27 - LandingZoneCreateRequestV1Dot1

Name	Description	Schema
additional_ou_name required	Additional Organization Unit Name Example : `Sandbox` Minimum length : `1` Maximum length : `128`	string
agree_yn required	Terms Agreement YN Example : `Y`	enum (Y, N)
audit_account_name required	Audit Account Name Example : `AUDIT` Pattern : `^[a-zA-Z0-9ㄱ-ㅎㅏ-ㅣ가-힣 \+=_\-@\[\]\.,]$` Minimum length* : `3` Maximum length : `30`	string
audit_login_id required	Login ID Example : `audit@samsung.com` Maximum length : `60`	string (email)
basic_ou_name required	Basic Organization Unit Name Example : `Security` Minimum length : `1` Maximum length : `128`	string
detective_guardrail_status required	Detective Guardrail Status Example : `ENABLED`	enum (ENABLED, DISABLED, ENABLING, DISABLING)
log_archive_account_name required	Log Archive Account Name Example : `LOG_ARCHIVE` Pattern : `^[a-zA-Z0-9ㄱ-ㅎㅏ-ㅣ가-힣 \+=_\-@\[\]\.,]$` Minimum length* : `3` Maximum length : `30`	string
log_archive_login_id required	Login ID Example : `log-archive@samsung.com` Maximum length : `60`	string (email)
sso_type required	Account Access Configuration Example : `ID_CENTER`	enum (ID_CENTER, SELF)

28 - LandingZoneCreateResponse

Name	Description	Schema	Default
job_id required	ID Example : `0a36e0746dbf4908acf0357829701381`	string
landing_zone_id required	Landing Zone ID Example : `2c8a138f8d78e1fc29a449dbfa8681`	string

29 - LandingZoneShowResponse

Name	Description	Schema	Default
landing_zone required		LandingZone

30 - LandingZoneShowResponseV1Dot1

Name	Description	Schema	Default
landing_zone required		LandingZoneV1Dot1

31 - LandingZoneUpdateRequest

Name	Description	Schema	Default
detective_guardrail_status required	Detective Guardrail Status Example : `ENABLED`	string

32 - LandingZoneV1Dot1

Name	Description	Schema	Default
agree_yn required	Terms Agreement YN Example : `Y`	string
created_at required	Created At Example : `2025-01-01T00:00:00.000Z`	string (date-time)
created_by required	Created By Example : `c23fb561c689455993874fa5d5ed4a2f`	string
creator_name optional	Creator Name Example : `John Doe na`	string	-
detective_guardrail_status required	Detective Guardrail Status Example : `ENABLED`	enum (ENABLED, DISABLED, ENABLING, DISABLING)
id required	Landing Zone ID Example : `2c8a138f8d78e1fc29a449dbfa8681`	string
identity_center_id optional	Identity Center ID Example : `0xnw6g1xh2q5`	any of [string, null]
modified_at required	Modified At Example : `2025-01-01T00:00:00.000Z`	string (date-time)
modified_by required	Modified By Example : `c23fb561c689455993874fa5d5ed4a2f`	string
modifier_name optional	Modifier Name Example : `Alice`	string	-
organization_id required	Organization ID Example : `o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5`	string
region required	Region Example : `kr-west1`	string
service_name required	Service Name Example : `Cloud Control`	string
srn required	Landing Zone SRN Example : `srn:dev2::a8a2f3c2659646ecaaf28fc8f783921a:::cloudcontrol:landingzone/f7a1ef0b17e34a37811cc2fa7a6bd50b`	string
sso_type required	Account Access Configuration Example : `ID_CENTER`	string
status required	State Example : `ACTIVE`	string
version_id required	Landing Zone Version Example : `1.0`	string

33 - ListGuardrailsForTargetResponse

Name	Description	Schema
count required	count Example : `20`	integer
guardrails required		array[GuardrailsForTargetSummary]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

34 - ListTargetsForGuardrailResponse

Name	Description	Schema
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]
targets required		any of [array[AccountsForGuardrail], array[OrganizationUnitsForGuardrail]]

35 - OrganizationUnitsForGuardrail

Name	Description	Schema
id required	Organization Unit ID Example : `ou-c29a138f8f1d78e24dbfa8681fc2fc8`	string
name required	Organization Unit Name Example : `score-organization-unit`	string
parent_unit_id optional	Root or Parent Organization Unit ID Example : `ou-fc8c29a138d78e24bf1fa86812fc8b`	any of [string, null]
parent_unit_name optional	Root or Parent Organization Unit Name Example : `parent-unit-name`	any of [string, null]