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

Return to the regular view of this page.

Management

1 - Cloud Control

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of CloudControl service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20251231

1.1 - CLIs

1.1.1 - AddBaselineAssignment

1.1.1.1 - 1.1

scpcli cloudcontrol baseline assignment add
--assignment_id <value>
--resource_type <value>
--landing_zone_id <value>
[--agree_yn <value>]
[--parent_unit_id <value>]
[--sso_user_name <value>]
[--sso_user_real_name <value>]

Description

add a new baseline assignment

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
assignment_id
required
stringRoot/Organization Unit/Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
resource_type
required
stringOU/AccountOU
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
agree_yn
optional
****Terms Agreement YNY
parent_unit_id
optional
stringRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
sso_user_name
optional
stringID Center User Nametestuser
sso_user_real_name
optional
stringID Center User Real Nametest user

Responses

NameDescriptionExample
job_idID0a36e0746dbf4908acf0357829701381
resource_idRoot/Organization Unit/Account IDou-b30e9fcc39f84a20bf9e7458e5ec3801
resource_typeOU/AccountOU

1.1.1.2 - 1.0

scpcli cloudcontrol baseline assignment add
--assignment_id <value>
--resource_type <value>
--landing_zone_id <value>
[--agree_yn <value>]
[--parent_unit_id <value>]
[--sso_user_name <value>]
[--sso_user_real_name <value>]

Description

add a new baseline assignment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
assignment_id
required
stringRoot/Organization Unit/Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
resource_type
required
stringOU/AccountOU
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
agree_yn
optional
****Terms Agreement YNY
parent_unit_id
optional
stringRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
sso_user_name
optional
stringID Center User Nametestuser
sso_user_real_name
optional
stringID Center User Real Nametest user

Responses

NameDescriptionExample
job_idID0a36e0746dbf4908acf0357829701381
resource_idRoot/Organization Unit/Account IDou-b30e9fcc39f84a20bf9e7458e5ec3801
resource_typeOU/AccountOU

1.1.2 - CreateAccountFactoryAccount

1.1.2.1 - 1.1

scpcli cloudcontrol account create from factory
--parent_unit_id <value>
--name <value>
--landing_zone_id <value>
[--email <value>]
[--sso_user_email <value>]
[--sso_user_name <value>]
[--sso_user_real_name <value>]

Description

create an account using account factory.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
parent_unit_id
required
stringParent Organization Unit IDou-b30e9fcc39f84a20bf9e7458e5ec3801
name
required
stringAccount Namefoo-account
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
email
optional
stringAccount Emailmyaccount@example.com
sso_user_email
optional
stringID Center User Emailuser_email@example.com
sso_user_name
optional
stringID Center User NameJohn Doe
sso_user_real_name
optional
stringID Center User Real NameJohn Doe

Responses

NameDescriptionExample
account_idOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
job_idID0a36e0746dbf4908acf0357829701381

1.1.2.2 - 1.0

scpcli cloudcontrol account create from factory
--parent_unit_id <value>
--name <value>
--landing_zone_id <value>
[--email <value>]
[--sso_user_email <value>]
[--sso_user_name <value>]
[--sso_user_real_name <value>]

Description

create an account using account factory.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
parent_unit_id
required
stringParent Organization Unit IDou-b30e9fcc39f84a20bf9e7458e5ec3801
name
required
stringAccount Namefoo-account
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
email
optional
stringAccount Emailmyaccount@example.com
sso_user_email
optional
stringID Center User Emailuser_email@example.com
sso_user_name
optional
stringID Center User NameJohn Doe
sso_user_real_name
optional
stringID Center User Real NameJohn Doe

Responses

NameDescriptionExample
account_idOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
job_idID0a36e0746dbf4908acf0357829701381

1.1.3 - CreateLandingZone

1.1.3.1 - 1.1

scpcli cloudcontrol landing zone create
--sso_type <value>
--log_archive_login_id <value>
--log_archive_account_name <value>
--detective_guardrail_status <value>
--basic_ou_name <value>
--audit_login_id <value>
--audit_account_name <value>
--agree_yn <value>
--additional_ou_name <value>

Description

Create a landing zone

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
sso_type
required
stringAccount Access ConfigurationID_CENTER
log_archive_login_id
required
stringLogin IDlog-archive@samsung.com
log_archive_account_name
required
stringLog Archive Account NameLOG_ARCHIVE
detective_guardrail_status
required
stringDetective Guardrail StatusENABLED
basic_ou_name
required
stringBasic Organization Unit NameSecurity
audit_login_id
required
stringLogin IDaudit@samsung.com
audit_account_name
required
stringAudit Account NameAUDIT
agree_yn
required
stringTerms Agreement YNY
additional_ou_name
required
stringAdditional Organization Unit NameSandbox

Responses

NameDescriptionExample
job_idID0a36e0746dbf4908acf0357829701381
landing_zone_idLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

1.1.3.2 - 1.0

scpcli cloudcontrol landing zone create
--sso_type <value>
--log_archive_login_id <value>
--log_archive_account_name <value>
--basic_ou_name <value>
--audit_login_id <value>
--audit_account_name <value>
--agree_yn <value>
--additional_ou_name <value>

Description

Create a landing zone

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
sso_type
required
stringAccount Access ConfigurationID_CENTER
log_archive_login_id
required
stringLogin IDlog-archive@samsung.com
log_archive_account_name
required
stringLog Archive Account NameLOG_ARCHIVE
basic_ou_name
required
stringBasic Organization Unit NameSecurity
audit_login_id
required
stringLogin IDaudit@samsung.com
audit_account_name
required
stringAudit Account NameAUDIT
agree_yn
required
stringTerms Agreement YNY
additional_ou_name
required
stringAdditional Organization Unit NameSandbox

Responses

NameDescriptionExample
job_idID0a36e0746dbf4908acf0357829701381
landing_zone_idLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

1.1.4 - DeleteLandingZone

1.1.4.1 - 1.1

scpcli cloudcontrol landing zone delete
--landing_zone_id <value>

Description

Delete a landing zone

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

1.1.4.2 - 1.0

scpcli cloudcontrol landing zone delete
--landing_zone_id <value>

Description

Delete a landing zone

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

1.1.5 - DisableGuardrailBindings

1.1.5.1 - 1.1

scpcli cloudcontrol guardrail disable
--unit_ids <value>
--guardrail_ids <value>
[--landing_zone_id <value>]

Description

disable guardrail bindings

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
unit_ids
required
arrayTarget Infoou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
guardrail_ids
required
arrayGuardrail List IDf98e76d54c32b10a9z8y7x6w5v4u3
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

1.1.5.2 - 1.0

scpcli cloudcontrol guardrail disable
--unit_ids <value>
--guardrail_ids <value>
[--landing_zone_id <value>]

Description

disable guardrail bindings

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
unit_ids
required
arrayTarget Infoou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
guardrail_ids
required
arrayGuardrail List IDf98e76d54c32b10a9z8y7x6w5v4u3
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

1.1.6 - EnableGuardrailBindings

1.1.6.1 - 1.1

scpcli cloudcontrol guardrail enable
--unit_ids <value>
--guardrail_ids <value>
[--landing_zone_id <value>]

Description

enable guardrail bindings

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
unit_ids
required
arrayTarget Infoou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
guardrail_ids
required
arrayGuardrail List IDf98e76d54c32b10a9z8y7x6w5v4u3
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

Responses

NameDescriptionExample
error_codeError CodeCloudControl.AlreadyEnabledGuardrails
failed_causedFailure Causeguardrail already enabled
guardrail_idGuardrail IDf98e76d54c32b10a9z8y7x6w5v4u3
response
unit_idTarget IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5

1.1.6.2 - 1.0

scpcli cloudcontrol guardrail enable
--unit_ids <value>
--guardrail_ids <value>
[--landing_zone_id <value>]

Description

enable guardrail bindings

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
unit_ids
required
arrayTarget Infoou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
guardrail_ids
required
arrayGuardrail List IDf98e76d54c32b10a9z8y7x6w5v4u3
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

Responses

NameDescriptionExample
error_codeError CodeCloudControl.AlreadyEnabledGuardrails
failed_causedFailure Causeguardrail already enabled
guardrail_idGuardrail IDf98e76d54c32b10a9z8y7x6w5v4u3
response
unit_idTarget IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5

1.1.7 - ListBaselineAssignments

1.1.7.1 - 1.1

scpcli cloudcontrol baseline assignment list
[--landing_zone_id <value>]
[--resource_type <value>]
[--assignment_id <value>]
[--status <value>]

Description

get baseline assignment list

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
resource_type
optional
****OU/AccountOU
assignment_id
optional
stringRoot/Organization Unit/Account IDou-b30e9fcc39f84a20bf9e7458e5ec3801
status
optional
****StateREGISTRATION_FAILED

Responses

NameDescriptionExample
idRoot/Organization Unit/Account IDou-b30e9fcc39f84a20bf9e7458e5ec3801
account_assigned_countRegistered Account Count3
account_countTotal Account Count4
detective_guardrail_statusDetective Guardrail StatusENABLED
detective_guardrail_typeDetective Guardrail TypeSSI
ou_assigned_countRegistered Organization Unit Count5
ou_countTotal Organization Unit Count10
preventive_guardrail_activated_countActivated Preventive Guardrail Count8
sso_user_nameID Center User Nametestuser
statusStateREGISTERED
typeOU/AccountOU

1.1.7.2 - 1.0

scpcli cloudcontrol baseline assignment list
[--landing_zone_id <value>]
[--resource_type <value>]
[--assignment_id <value>]
[--status <value>]

Description

get baseline assignment list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
resource_type
optional
****OU/AccountOU
assignment_id
optional
stringRoot/Organization Unit/Account IDou-b30e9fcc39f84a20bf9e7458e5ec3801
status
optional
****StateREGISTRATION_FAILED

Responses

NameDescriptionExample
idRoot/Organization Unit/Account IDou-b30e9fcc39f84a20bf9e7458e5ec3801
account_assigned_countRegistered Account Count3
account_countTotal Account Count4
ou_assigned_countRegistered Organization Unit Count5
ou_countTotal Organization Unit Count10
preventive_guardrail_activated_countActivated Preventive Guardrail Count8
sso_user_nameID Center User Nametestuser
statusStateREGISTERED
typeOU/AccountOU

1.1.8 - ListGuardrails

1.1.8.1 - 1.1

scpcli cloudcontrol guardrail list
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--exclude_unit_id <value>]
[--guidance <value>]
[--service_name <value>]
[--status <value>]

Description

get guardrails list

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGuardrail Namefoo-guardrail
exclude_unit_id
optional
stringLinked(Exclusion) Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
guidance
optional
stringPolicy GuidanceMANDATORY
service_name
optional
stringOrganizationiam
status
optional
stringApplication StatusENABLED

Responses

NameDescriptionExample
idGuardrail ID2c8a138f8d78e1fc29a449dbfa8681
binding_ous
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
descriptionGuardrail DescriptionThis is an example guardrail.
guidancePolicy GuidanceMANDATORY
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameGuardrail Namefoo-guardrail
service_nameOrganizationiam
srnGuardrail SRNsrn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681
statusApplication Status
typeGuardrail TypePREVENTIVE

1.1.8.2 - 1.0

scpcli cloudcontrol guardrail list
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--exclude_unit_id <value>]
[--guidance <value>]
[--service_name <value>]
[--status <value>]

Description

get guardrails list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGuardrail Namefoo-guardrail
exclude_unit_id
optional
stringLinked(Exclusion) Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
guidance
optional
stringPolicy GuidanceMANDATORY
service_name
optional
stringOrganizationiam
status
optional
stringApplication StatusENABLED

Responses

NameDescriptionExample
idGuardrail ID2c8a138f8d78e1fc29a449dbfa8681
binding_ous
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
descriptionGuardrail DescriptionThis is an example guardrail.
guidancePolicy GuidanceMANDATORY
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameGuardrail Namefoo-guardrail
service_nameOrganizationiam
srnGuardrail SRNsrn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681
statusApplication Status
typeGuardrail TypePREVENTIVE

1.1.9 - ListGuardrailsForTarget

1.1.9.1 - 1.1

scpcli cloudcontrol target guardrail list
--target_id <value>
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

list guardrails for target

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
target_id
required
stringTarget IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGuardrail Nameguardrail-example

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
guidancePolicy GuidanceMANDATORY
link_typesLink Type{‘directed’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’}], ‘inherited’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’}]}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameGuardrail Namefoo-guardrail
service_nameOrganizationiam
typeGuardrail TypePREVENTIVE

1.1.9.2 - 1.0

scpcli cloudcontrol target guardrail list
--target_id <value>
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

list guardrails for target

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
target_id
required
stringTarget IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGuardrail Nameguardrail-example

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
guidancePolicy GuidanceMANDATORY
link_typesLink Type{‘directed’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’}], ‘inherited’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’}]}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameGuardrail Namefoo-guardrail
service_nameOrganizationiam
typeGuardrail TypePREVENTIVE

1.1.10 - ListTargetsForGuardrail

1.1.10.1 - 1.1

scpcli cloudcontrol guardrail target list
--target_type <value>
--guardrail_id <value>
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

list targets for guardrail

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
target_type
required
****Target TypeACCOUNT
guardrail_id
required
stringGuardrail IDf98e76d54c32b10a9z8y7x6w5v4u3
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringTarget Nameou-test

Responses

NameDescriptionExample
idOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
emailAccount Emailscore@samsung.com
nameAccount Namescore-account
parent_unit_idRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_nameRoot or Parent Organization Unit Nameparent-unit-name

1.1.10.2 - 1.0

scpcli cloudcontrol guardrail target list
--target_type <value>
--guardrail_id <value>
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

list targets for guardrail

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
target_type
required
****Target TypeACCOUNT
guardrail_id
required
stringGuardrail IDf98e76d54c32b10a9z8y7x6w5v4u3
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringTarget Nameou-test

Responses

NameDescriptionExample
idOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
emailAccount Emailscore@samsung.com
nameAccount Namescore-account
parent_unit_idRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_nameRoot or Parent Organization Unit Nameparent-unit-name

1.1.11 - RemoveBaselineAssignment

1.1.11.1 - 1.1

scpcli cloudcontrol baseline assignment remove
--assignment_id <value>
--resource_type <value>
--landing_zone_id <value>

Description

remove a specific baseline assignment

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
assignment_id
required
stringRoot/Organization Unit/Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
resource_type
required
stringOU/AccountACCOUNT
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

1.1.12 - SetLandingZone

1.1.12.1 - 1.1

scpcli cloudcontrol landing zone set
--landing_zone_id <value>
--detective_guardrail_status <value>

Description

Set a landing zone

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
detective_guardrail_status
required
stringDetective Guardrail StatusENABLED

1.1.13 - ShowGuardrail

1.1.13.1 - 1.1

scpcli cloudcontrol guardrail show
--guardrail_id <value>
[--landing_zone_id <value>]

Description

show a specific guardrail.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
guardrail_id
required
stringGuardrail ID2c8a138f8d78e1fc29a449dbfa8681
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

Responses

NameDescriptionExample
idGuardrail ID2c8a138f8d78e1fc29a449dbfa8681
binding_ous
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
descriptionGuardrail DescriptionThis is an example guardrail.
guidancePolicy GuidanceMANDATORY
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameGuardrail Namefoo-guardrail
service_nameOrganizationiam
srnGuardrail SRNsrn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681
statusApplication Status
typeGuardrail TypePREVENTIVE

1.1.13.2 - 1.0

scpcli cloudcontrol guardrail show
--guardrail_id <value>
[--landing_zone_id <value>]

Description

show a specific guardrail.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
guardrail_id
required
stringGuardrail ID2c8a138f8d78e1fc29a449dbfa8681
landing_zone_id
optional
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

Responses

NameDescriptionExample
idGuardrail ID2c8a138f8d78e1fc29a449dbfa8681
binding_ous
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
descriptionGuardrail DescriptionThis is an example guardrail.
guidancePolicy GuidanceMANDATORY
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameGuardrail Namefoo-guardrail
service_nameOrganizationiam
srnGuardrail SRNsrn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681
statusApplication Status
typeGuardrail TypePREVENTIVE

1.1.14 - ShowLandingZone

1.1.14.1 - 1.1

scpcli cloudcontrol landing zone show
--landing_zone_id <value>

Description

Show a landing zone

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

Responses

NameDescriptionExample
idLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
agree_ynTerms Agreement YNY
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
detective_guardrail_statusDetective Guardrail StatusENABLED
identity_center_idIdentity Center ID0xnw6g1xh2q5
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
service_nameService NameCloud Control
srnLanding Zone SRNsrn:dev2::a8a2f3c2659646ecaaf28fc8f783921a:::cloudcontrol:landingzone/f7a1ef0b17e34a37811cc2fa7a6bd50b
sso_typeAccount Access ConfigurationID_CENTER
statusStateACTIVE
version_idLanding Zone Version1.0

1.1.14.2 - 1.0

scpcli cloudcontrol landing zone show
--landing_zone_id <value>

Description

Show a landing zone

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681

Responses

NameDescriptionExample
idLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
agree_ynTerms Agreement YNY
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
identity_center_idIdentity Center ID0xnw6g1xh2q5
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
service_nameService NameCloud Control
srnLanding Zone SRNsrn:dev2::a8a2f3c2659646ecaaf28fc8f783921a:::cloudcontrol:landingzone/f7a1ef0b17e34a37811cc2fa7a6bd50b
sso_typeAccount Access ConfigurationID_CENTER
statusStateACTIVE
version_idLanding Zone Version1.0

1.1.15 - UpdateBaselineAssignment

1.1.15.1 - 1.1

scpcli cloudcontrol baseline assignment update
--assignment_id <value>
--landing_zone_id <value>
[--agree_yn <value>]

Description

update a specific baseline assignment.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
assignment_id
required
stringRoot/Organization Unit/Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
agree_yn
optional
****Terms Agreement YNY

1.1.15.2 - 1.0

scpcli cloudcontrol baseline assignment update
--assignment_id <value>
--landing_zone_id <value>
[--agree_yn <value>]

Description

update a specific baseline assignment.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
assignment_id
required
stringRoot/Organization Unit/Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
landing_zone_id
required
stringLanding Zone ID2c8a138f8d78e1fc29a449dbfa8681
agree_yn
optional
****Terms Agreement YNY

2 - Cloud Monitoring

Overview

None

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.0CURRENT-

2.1 - CLIs

2.1.1 - CreateEventPolicy

2.1.1.1 - 1.0

scpcli cloudmonitoring event eventpolicy create
--value <value>
--comparisonoperator <value>
--minvalue <value>
--mincomparisonoperator <value>
--maxvalue <value>
--maxcomparisonoperator <value>
--thresholdtype <value>
--eventpolicystatisticstype <value>
--eventpolicystatisticsperiod <value>
--metrickey <value>
--islogmetric <value>
--ftcount <value>
--eventlevel <value>
--disableyn <value>
--productresourceid <value>
[--notificationrecipients <value>]
[--eventmessageprefix <value>]
[--eventoccurtimezone <value>]
[--metricname <value>]
[--objectdisplayname <value>]
[--objectname <value>]
[--objecttype <value>]
[--podobjectdisplayname <value>]
[--podobjectname <value>]
[--metricfunction <value>]
--x-resourcetype <value>

Description

Create Event Policy

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
value
required
number10
comparisonoperator
required
string비교 연산자LT
minvalue
required
number최소 값80
mincomparisonoperator
required
string최소 비교 연산자GT
maxvalue
required
number최대 값90
maxcomparisonoperator
required
string최대 비교 연산자LT
thresholdtype
required
string임계치 유형 - 임계치를 범위로 지정할 경우에는 “RANGE_VALUE"를, 임계치를 단일값으로 지정할 경우에는 “SINGLE_VALUE” 지정해야 합니다.RANGE_VALUE
eventpolicystatisticstype
required
string이벤트 정책 통계 유형MAX
eventpolicystatisticsperiod
required
integer이벤트 정책 통계 기간 - 단위: 분10
metrickey
required
string메트릭 키system.diskio.read.bytes
islogmetric
required
string로그 메트릭 여부N
ftcount
required
integer결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값3
eventlevel
required
string이벤트 레벨WARNING
disableyn
required
stringswagger.event.eventPolicyResponse.disableYn.valueN
productresourceid
required
stringProduct Resource ID - Product Resource ID can be viewed using @[ListAccountResources].INSTANCE-c4Hsd27ttDaLw533X4B6Sp
notificationrecipients
optional
array이벤트 알림 수신인 정보 - 알림 대상자 정보는 10개까지 지정할 수 있습니다.'{"notificationMethods": [{"eventLevel": "FATAL", "notificationMethod": "", "sendMethod": ["MAIL"]}], "recipientKey": "1347", "recipientType": "USER"}'
eventmessageprefix
optional
string이벤트 메시지 접두사SCP
eventoccurtimezone
optional
stringswagger.event.eventPolicyResponse.eventOccurTimeZone.valueGMT+9
metricname
optional
string-
objectdisplayname
optional
string오브젝트 이름dm0
objectname
optional
string오브젝트 이름dm0
objecttype
optional
string개별항목 유형SCP
podobjectdisplayname
optional
stringswagger.event.eventPolicyResponse.podObjectDisplayName.valuedm0
podobjectname
optional
stringswagger.event.eventPolicyResponse.podObjectName.valuedm0
metricfunction
optional
string메트릭 함수 - 유효한 값: [delta] - 이벤트 발생 여부를 판단하기 위해 성능항목의 현재 값을 사용할지, 이전 값과 현재 값의 차이를 사용할지를 지정합니다. - 이전 값과 현재 값의 차이를 사용하고자 할 경우에만 delta로 지정합니다.delta
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
eventPolicyStatisticsPeriod이벤트 정책 통계 기간 - 단위: 분10
eventPolicyStatisticsType이벤트 정책 통계 유형MAX

2.1.2 - DeleteEventPolicy

2.1.2.1 - 1.0

scpcli cloudmonitoring event eventpolicy delete
--eventpolicyid <value>
--x-resourcetype <value>

Description

Delete Event policy

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
eventpolicyid
required
integerEvent policy ID to delete - Event Policy ID can be viewed using @[ListEventPolicies].7226
x-resourcetype
required
stringResource Type-

2.1.3 - ListAccountEvents

2.1.3.1 - 1.0

scpcli cloudmonitoring event accountevent list
--queryenddt <value>
--querystartdt <value>
--eventstate <value>
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Search Account Event List

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
queryenddt
required
stringQuery End Date2021-10-23T23:59:59.000Z
querystartdt
required
stringQuery Start Date2021-10-23T18:00:00.000Z
eventstate
required
stringEvent StateALL
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
durationSecond이벤트 지속 시간 - 단위: 초100
endDt종료일시2021-10-23T23:59:59Z
eventId이벤트 아이디
eventLevel이벤트 레벨FATAL
eventMessage이벤트 메시지
eventPolicyId이벤트 정책 아이디7240
eventStateEvent StateACTIVE
metricKey메트릭 키system.cpu.system.norm.pct
metricName메트릭 이름system.cpu.system.norm.pct
objectDisplayName오브젝트 이름CPU0
objectName오브젝트 이름CPU0
objectType개별항목 유형cluster
objectTypeName개별항목 유형 이름cluster
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
productTypeName상품 유형 이름Virtual Server
startDt시작일시2021-10-23T18:00:00Z

2.1.4 - ListAccountMember

2.1.4.1 - 1.0

scpcli cloudmonitoring product accountmember list
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Search members included in an Account.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
companyNameswagger.product.ProjectMemberDto.companyName.value삼성SDS
createdByswagger.product.ProjectMemberDto.createdBy.value469
createdByEmailswagger.product.ProjectMemberDto.createdByEmail.valuesoonshin.lee@cloud.com
createdByNameswagger.product.ProjectMemberDto.createdByName.value이순신
createdDtswagger.product.ProjectMemberDto.userTimezone.value2021-08-06T10:23:41.547Z
emailswagger.product.ProjectMemberDto.userEmail.valuekdhong@cloud.com
lastAccessDtswagger.product.ProjectMemberDto.lastAccessDt.value2022-11-06T10:23:41.547Z
modifiedByswagger.product.ProjectMemberDto.modifiedBy.value469
modifiedByEmailswagger.product.ProjectMemberDto.modifiedByEmail.valuesoonshin.lee@cloud.com
modifiedByNameswagger.product.ProjectMemberDto.modifiedByName.value이순신
modifiedDtswagger.product.ProjectMemberDto.modifiedDt.value2021-08-06T10:23:41.547Z
organizationIdswagger.product.ProjectMemberDto.organizationId.value
positionNameswagger.product.ProjectMemberDto.positionName.value프로
userGroupCountswagger.product.ProjectMemberDto.userGroupCount.value10
userIdswagger.product.ProjectMemberDto.userId.value1984
userNameswagger.product.ProjectMemberDto.userName.value홍길동

2.1.5 - ListAccountResources

2.1.5.1 - 1.0

scpcli cloudmonitoring product accountresource list
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search Resource included in an Account.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
accountId프로젝트 아이디UqXgOSnoqOfKB0_LKO6xId
endDt상품 삭제 일시9999-12-31T23:59:59.999Z
lastEventLevel최종 이벤트 레벨WARNING
poolName풀 이름POOL-A8-C1DpGqRdQMlfNXdJxLb
productIpAddress상품 IP주소192.168.245.161
productName상품 이름VM-Server-01
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productState상품 상태 - 유효한 값 : Running, DownRunning
productTypeCode상품 유형코드VM
productTypeName상품 유형이름Virtual Server
startDt상품 생성 일시2021-10-23T08:30:00Z

2.1.6 - ListAddressBookMembers

2.1.6.1 - 1.0

scpcli cloudmonitoring product addressbookmember list
--addrbookid <value>
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Search address book members

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
addrbookid
required
integerAddress book ID - Address book IDs can be obtained from @[ListAddressBooks].-
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
userEmail사용자 이메일kdhong@cloud.com
userId사용자 리소스 아이디1346
userLanguage사용자 언어ko
userMobileTelNo사용자 휴대전화번호010-0000-0000
userName사용자 이름홍길동
userTimezone사용자 타임존Asia/Seoul

2.1.7 - ListAddressBooks

2.1.7.1 - 1.0

scpcli cloudmonitoring product addressbook list
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Search a list of address books created by user.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
addrBookName주소록 이름contact name
addrbookId주소록 아이디74
createdBy생성자 아이디1984
createdByName생성자 이름김삼성
createdDt생성 일시2021-10-23T22:00:00Z
memberCount멤버 수10

2.1.8 - ListEventPolicies

2.1.8.1 - 1.0

scpcli cloudmonitoring event eventpolicy list
--productresourceid <value>
[--metrickey <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search Event Policies

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
productresourceid
required
stringProduct Resource ID - Product Resource ID can be viewed using @[ListAccountResources].c94607c8-6a15-4e13-84f3-99cb77d478e3
metrickey
optional
stringMetric Key - Metric Key can be viewed using @[ListMetrics].system.cpu.system.pct
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
checkAsg
createBy
createById
eventLevel이벤트 레벨WARNING
eventMessagePrefix이벤트 메시지 접두사SCP
eventOccurTimeZoneswagger.event.eventPolicyResponse.eventOccurTimeZone.valueGMT+9
eventPolicyId이벤트 정책 아이디7226
eventPolicyStatistics
eventThreshold
ftCount결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값3
isLogMetric로그 메트릭 여부N
metricDescription메트릭 설명커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
metricDescriptionEn메트릭 설명Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
metricKey메트릭 키system.cpu.system.pct
metricName메트릭 이름system.cpu.system.pct
objectName오브젝트 이름cpu0
productName상품 이름VM-002
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productSq상품 시퀀스7321
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
updateBy
updateById

2.1.9 - ListEventPolicyHistories

2.1.9.1 - 1.0

scpcli cloudmonitoring event eventpolicyhistory list
--eventpolicyid <value>
--queryenddt <value>
--querystartdt <value>
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search event policy histories

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
eventpolicyid
required
integerEvent Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies].7226
queryenddt
required
stringQuery End Date2021-10-23T23:59:59.000Z
querystartdt
required
stringQuery Start Date2021-10-23T18:00:00.000Z
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
createBy
createById
disableObjectswagger.event.eventPolicyResponse.disableObject.valueN
disableYnswagger.event.eventPolicyResponse.disableObject.valueN
eventLevel이벤트 레벨WARNING
eventMessagePrefix이벤트 메시지 접두사SCP
eventOccurTimeZoneswagger.event.eventPolicyResponse.eventOccurTimeZone.valueGMT+9
eventPolicyHistoryId이벤트 정책 이력 아이디8759
eventPolicyHistoryType이벤트 정책 이력 유형 - C : 등록, U : 수정, D : 삭제U
eventPolicyId이벤트 정책 아이디7240
eventPolicyStatistics
eventThreshold
ftCount결함허용 개수3
metricDescription메트릭 설명커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
metricDescriptionEn메트릭 설명Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
metricKey메트릭 키system.cpu.system.pct
metricName메트릭 이름system.cpu.system.pct
metricUnit메트릭 단위%
modifiedBy
modifiedByName
modifiedDt
notificationRecipientHistory
objectDisplayName오브젝트 이름cpu0
objectName오브젝트 이름cpu0
objectType개별항목 유형cluster
productName상품 이름VM-Server-01
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
updateBy
updateById

2.1.10 - ListEventPolicyNotification

2.1.10.1 - 1.0

scpcli cloudmonitoring event eventpolicynotification list
--eventpolicyid <value>
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search Event Policy Notification

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
eventpolicyid
required
integerEvent Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies].7226
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
addrbookAdditionalInfo
notificationMethods알림 메소드 정보
recipientKey수신인 키 - 수신인 키는 @[프로젝트 멤버 조회] 또는 @[사용자의 주소록 목록 조회]를 이용하여 조회합니다.1984
recipientName수신인 이름홍길동
recipientType수신인 유형 - USER : 사용자, ADDRBOOK : 주소록USER
userAdditionalInfo

2.1.11 - ListMetricPefData

2.1.11.1 - 1.0

scpcli cloudmonitoring product metricperfdata list
--querystartdt <value>
--queryenddt <value>
--metricdataconditions <value>
[--ignoreinvalid <value>]
--x-resourcetype <value>

Description

Search the performance values of the collected metrics. Up to 10 query conditions can be specified, and the maximum query period is 24 hours.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
querystartdt
required
string조회 시작 일시2022-08-07T23:50:00.000Z
queryenddt
required
string조회 종료 일시2022-08-07T23:59:00.000Z
metricdataconditions
required
array메트릭 데이터 조건'{"metricKey": "system.diskio.read.bytes", "objectType": "replicaset", "productResourceInfos": [{"objectList": ["kube-01", "kube-02"], "productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp"}], "statisticsPeriod": 5, "statisticsTypeList": ["SUM", "MIN"]}'
ignoreinvalid
optional
string유효하지 않은 값 제외 여부Y
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
metricKey메트릭 키system.filesystem.used.bytes
metricName메트릭 이름system.filesystem.used.bytes
metricType메트릭 유형NUM
metricUnit메트릭 단위bytes
objectDisplayName개별항목 출력 이름dm-1
objectName개별항목 이름dm-1
objectType개별항목 유형replicaset
perfData성능 데이터[{’time’: 1627378200000, ‘value’: ‘0.0766’}]
productName상품의 이름VM-Server-01
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
statisticsPeriod통계 집계 주기 (단위: 분)5
statisticsType통계 유형SUM

2.1.12 - ListMetrics

2.1.12.1 - 1.0

scpcli cloudmonitoring product metric list
[--producttypecode <value>]
[--objecttype <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

View the list of metrics provided by Monitoring. You can view the full list of metrics or the list of metrics for each service type.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
producttypecode
optional
stringProduct type code - Product type codes can be obtained using @[ListServiceMonitoring]. If not specified, the entire metric list will be retrieved.VM
objecttype
optional
stringObject Type - Only available for services that have subtypes, such as when the 'productTypeCode' is 'Kubernetes' or 'Load Balancer'.node
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
disableObjectswagger.product.MetricInfoDto.disableObject.valueN
displayUnit
fixedUnit메트릭 단위 (고정)sec
isLogMetric로그 메트릭 여부N
isObjectExist개별항목 성능 존재 여부Y
metricDescription메트릭 설명커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
metricDescriptionEn메트릭 설명Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
metricKey메트릭 키system.filesystem.used.bytes
metricName메트릭 이름FileSystem
metricOrder메트릭 순서1
metricSetKeyswagger.product.MetricInfoDto.metricSetKey.valuesystem.filesystem
metricSetName메트릭 세트 이름FileSystem
metricType메트릭 유형NUM
metricUnit메트릭 단위bytes
objectKeyName오브젝트 키 이름system.core.iowait.pct
objectTypeswagger.product.MetricInfoDto.disableObject.valueN
objectTypeNameEngswagger.product.MetricInfoDto.disableObject.valueN
objectTypeNameLocswagger.product.MetricInfoDto.disableObject.valueN
perfTitleswagger.product.MetricInfoDto.perfTitle.valueFile System
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
productTypeCode상품 유형 코드VM
productTypeName상품 유형 이름Virtual Server

2.1.13 - ListResourceEvents

2.1.13.1 - 1.0

scpcli cloudmonitoring event resourceevent list
--queryenddt <value>
--querystartdt <value>
--eventstate <value>
--productresourceid <value>
[--metrickey <value>]
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search a list of events that occurred on a product resource.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
queryenddt
required
stringQuery End Date2021-10-23T23:59:59.000Z
querystartdt
required
stringQuery Start Date2021-10-23T18:00:00.000Z
eventstate
required
stringEvent StateALL
productresourceid
required
stringProduct Resource ID - Product Resource ID can be viewed using @[ListAccountResources].INSTANCE-c4Hsd27ttDaLw533X4B6Sp
metrickey
optional
stringMetric Key - Metric Key can be viewed using @[ListMetrics].system.cpu.system.pct
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
durationSecond이벤트 지속 시간 - 단위: 초100
endDt종료일시2021-10-23T23:59:59Z
eventId이벤트 아이디
eventLevel이벤트 레벨FATAL
eventMessage이벤트 메시지
eventPolicyId이벤트 정책 아이디7240
eventStateEvent StateACTIVE
metricKey메트릭 키system.cpu.system.norm.pct
metricName메트릭 이름system.cpu.system.norm.pct
objectDisplayName오브젝트 이름CPU0
objectName오브젝트 이름CPU0
objectType개별항목 유형cluster
objectTypeName개별항목 유형 이름cluster
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
productTypeName상품 유형 이름Virtual Server
startDt시작일시2021-10-23T18:00:00Z

2.1.14 - ListService

2.1.14.1 - 1.0

scpcli cloudmonitoring product service list
[--productcategorycode <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Search a list of product types supported by monitoring.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
productcategorycode
optional
stringProduct type category - If not specified, the entire product type code will be retrieved.Compute
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-

Responses

NameDescriptionExample
parentProductTypeName부모 상품 이름Compute
productTypeCode상품 코드VM
productTypeName상품 이름Virtual Server
stateMetricKey상태 메트릭 키vsphere.mxvm.runtime.state

2.1.15 - SetEventPolicy

2.1.15.1 - 1.0

scpcli cloudmonitoring event eventpolicy set
--eventpolicyid <value>
--value <value>
--comparisonoperator <value>
--minvalue <value>
--mincomparisonoperator <value>
--maxvalue <value>
--maxcomparisonoperator <value>
--thresholdtype <value>
--eventpolicystatisticstype <value>
--eventpolicystatisticsperiod <value>
--ftcount <value>
--eventlevel <value>
--disableyn <value>
[--notificationrecipients <value>]
[--eventmessageprefix <value>]
[--eventoccurtimezone <value>]
[--objectdisplayname <value>]
[--objectname <value>]
[--objecttype <value>]
[--podobjectdisplayname <value>]
[--podobjectname <value>]
[--metricfunction <value>]
--x-resourcetype <value>

Description

Set Event Policy

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
eventpolicyid
required
integerEvent policy ID to modify - Event Policy ID can be viewed using @[ListEventPolicies].7226
value
required
number10
comparisonoperator
required
string비교 연산자LT
minvalue
required
number최소 값80
mincomparisonoperator
required
string최소 비교 연산자GT
maxvalue
required
number최대 값90
maxcomparisonoperator
required
string최대 비교 연산자LT
thresholdtype
required
string임계치 유형 - 임계치를 범위로 지정할 경우에는 “RANGE_VALUE"를, 임계치를 단일값으로 지정할 경우에는 “SINGLE_VALUE” 지정해야 합니다.RANGE_VALUE
eventpolicystatisticstype
required
string이벤트 정책 통계 유형MAX
eventpolicystatisticsperiod
required
integer이벤트 정책 통계 기간 - 단위: 분10
ftcount
required
integer결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값3
eventlevel
required
string이벤트 레벨WARNING
disableyn
required
stringswagger.event.eventPolicyResponse.disableYn.valueN
notificationrecipients
optional
array이벤트 알림 수신인 정보'{"notificationMethods": [{"eventLevel": "FATAL", "notificationMethod": "", "sendMethod": ["MAIL"]}], "recipientKey": "1347", "recipientType": "USER"}'
eventmessageprefix
optional
string이벤트 메시지 접두사SCP
eventoccurtimezone
optional
stringswagger.event.eventPolicyResponse.eventOccurTimeZone.valueGMT+9
objectdisplayname
optional
string오브젝트 이름cpu0
objectname
optional
string오브젝트 이름cpu0
objecttype
optional
string개별항목 유형cluster
podobjectdisplayname
optional
stringswagger.event.eventPolicyResponse.podObjectName.valuecpu0
podobjectname
optional
stringswagger.event.eventPolicyResponse.podObjectName.valuecpu0
metricfunction
optional
string메트릭 함수 - 유효한 값: [delta] - 이벤트 발생 여부를 판단하기 위해 성능항목의 현재 값을 사용할지, 이전 값과 현재 값의 차이를 사용할지를 지정합니다. - 이전 값과 현재 값의 차이를 사용하고자 할 경우에만 delta로 지정합니다.delta
x-resourcetype
required
stringResource Type-

2.1.16 - ShowEventNotificationStates

2.1.16.1 - 1.0

scpcli cloudmonitoring event eventnotificationstate show
--eventid <value>
[--page <value>]
[--size <value>]
[--sort <value>]
--x-resourcetype <value>

Description

Search Event Notification States

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
eventid
required
stringEvent ID - Event ID can be viewed using @[ListResourceEvents].-
page
optional
integerPage Number (default: 0)0
size
optional
integerPage Contents Size (default: 10)10
sort
optional
arraySorting Field List-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
notificationStates이벤트 알림 상태
user
userEmail사용자 이메일kdhong@cloud.com
userId사용자 아이디1984
userMobileTelNo사용자 휴대 전화번호010-000-0000
userNameNotification사용자 이름홍길동

2.1.17 - ShowEventPolicy

2.1.17.1 - 1.0

scpcli cloudmonitoring event eventpolicy show
--eventpolicyid <value>
--x-resourcetype <value>

Description

Show Event Policy

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
eventpolicyid
required
integerEvent Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies].7226
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
eventPolicyStatisticsPeriod이벤트 정책 통계 기간 - 단위: 분10
eventPolicyStatisticsType이벤트 정책 통계 유형MAX

2.1.18 - ShowResourceEvent

2.1.18.1 - 1.0

scpcli cloudmonitoring event resourceevent show
--eventid <value>
--x-resourcetype <value>

Description

Show Resource Event

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
eventid
required
stringEvent ID - Event ID can be viewed using @[ListResourceEvents].-
x-resourcetype
required
stringResource Type-

Responses

NameDescriptionExample
checkAsg
createBy
createById
eventLevel이벤트 레벨WARNING
eventMessagePrefix이벤트 메시지 접두사SCP
eventOccurTimeZoneswagger.event.eventPolicyResponse.eventOccurTimeZone.valueGMT+9
eventPolicyId이벤트 정책 아이디7226
eventPolicyStatistics
eventThreshold
ftCount결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값3
isLogMetric로그 메트릭 여부N
metricDescription메트릭 설명커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)
metricDescriptionEn메트릭 설명Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)
metricKey메트릭 키system.cpu.system.pct
metricName메트릭 이름system.cpu.system.pct
objectName오브젝트 이름cpu0
productName상품 이름VM-002
productResourceId상품 리소스 아이디INSTANCE-c4Hsd27ttDaLw533X4B6Sp
productSq상품 시퀀스7321
productTargetType메트릭 대상 유형system.core.id 별
productTargetTypeEn메트릭 대상 유형By system.core.id
updateBy
updateById

3 - IAM

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of IAM service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.3CURRENT-
1.2SUPPORTED20260930
1.1DEPRECATED20260531
1.0DEPRECATED20260223

3.1 - CLIs

3.1.1 - Add a permission into the resource based policy

3.1.1.1 - 1.3

scpcli iam permission add
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Add a permission into the resource based policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

Responses

NameDescriptionExample
StatementStatement{‘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’}

3.1.1.2 - 1.2

scpcli iam permission add
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Add a permission into the resource based policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

Responses

NameDescriptionExample
StatementStatement{‘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’}

3.1.1.3 - 1.1

scpcli iam permission add
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Add a permission into the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

Responses

NameDescriptionExample
StatementStatement{‘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’}

3.1.1.4 - 1.0

scpcli iam permission add
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Add a permission into the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

Responses

NameDescriptionExample
StatementStatement{‘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’}

3.1.2 - Add a user to a group

3.1.2.1 - 1.3

scpcli iam group user add
--group_id <value>
--user_id <value>

Description

Add a user to a group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
user_id
required
stringGroup Member User IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
user_emailGroup Member Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_nameGroup Member Last Name, First NameKim Samsung

3.1.2.2 - 1.2

scpcli iam group user add
--group_id <value>
--user_id <value>

Description

Add a user to a group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
user_id
required
stringGroup Member User IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
user_emailGroup Member Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_nameGroup Member Last Name, First NameKim Samsung

3.1.2.3 - 1.1

scpcli iam group user add
--group_id <value>
--user_id <value>

Description

Add a user to a group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
user_id
required
stringGroup Member User IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
user_emailGroup Member Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_nameGroup Member Last Name, First NameKim Samsung

3.1.2.4 - 1.0

scpcli iam group user add
--group_id <value>
--user_id <value>

Description

Add a user to a group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
user_id
required
stringGroup Member User IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
user_emailGroup Member Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_nameGroup Member Last Name, First NameKim Samsung

3.1.3 - Assign policies to the group

3.1.3.1 - 1.3

scpcli iam group policy create
--group_id <value>
--policy_ids <value>

Description

Assign policies to the group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
policy_ids
required
arrayGroup Policy ID List37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.3.2 - 1.2

scpcli iam group policy create
--group_id <value>
--policy_ids <value>

Description

Assign policies to the group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
policy_ids
required
arrayGroup Policy ID List37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.3.3 - 1.1

scpcli iam group policy create
--group_id <value>
--policy_ids <value>

Description

Assign policies to the group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
policy_ids
required
arrayGroup Policy ID List37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.3.4 - 1.0

scpcli iam group policy create
--group_id <value>
--policy_ids <value>

Description

Assign policies to the group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
policy_ids
required
arrayGroup Policy ID List37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.4 - Assign policies to user

3.1.4.1 - 1.3

scpcli iam user policy create
--user_id <value>
[--policy_ids <value>]

Description

Assign policies to user

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
policy_ids
optional
arrayUser Policy Bindings-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.4.2 - 1.2

scpcli iam user policy create
--user_id <value>
[--policy_ids <value>]

Description

Assign policies to user

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
policy_ids
optional
arrayUser Policy Bindings-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.4.3 - 1.1

scpcli iam user policy create
--user_id <value>
[--policy_ids <value>]

Description

Assign policies to user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
policy_ids
optional
arrayUser Policy Bindings-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.4.4 - 1.0

scpcli iam user policy create
--user_id <value>
[--policy_ids <value>]

Description

Assign policies to user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
policy_ids
optional
arrayUser Policy Bindings-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.5 - Attach policies to Role

3.1.5.1 - 1.3

scpcli iam role policy binding attach
--role_id <value>
--policy_ids <value>

Description

Attach policies to Role

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
policy_ids
required
arrayPolicy ID List to Attach to Role-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.5.2 - 1.2

scpcli iam role policy binding attach
--role_id <value>
--policy_ids <value>

Description

Attach policies to Role

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
policy_ids
required
arrayPolicy ID List to Attach to Role-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.5.3 - 1.1

scpcli iam role policy binding attach
--role_id <value>
--policy_ids <value>

Description

Attach policies to Role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
policy_ids
required
arrayPolicy ID List to Attach to Role-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.5.4 - 1.0

scpcli iam role policy binding attach
--role_id <value>
--policy_ids <value>

Description

Attach policies to Role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
policy_ids
required
arrayPolicy ID List to Attach to Role-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.6 - Create a group

3.1.6.1 - 1.3

scpcli iam group create
--name <value>
--description <value>
[--policy_ids <value>]
[--tags <value>]
[--user_ids <value>]

Description

Create a group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringGroup NameTestGroup
description
required
stringGroup DescriptionDescriptions for group
policy_ids
optional
arrayGroup Policy ID List37f2e31ff86b415698d7e8eeafab445d
tags
optional
arrayGroup Tag{'key': 'company', 'value': 'SDS'}
user_ids
optional
arrayGroup Member User ID Listf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.6.2 - 1.2

scpcli iam group create
--name <value>
--description <value>
[--policy_ids <value>]
[--tags <value>]
[--user_ids <value>]

Description

Create a group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
name
required
stringGroup NameTestGroup
description
required
stringGroup DescriptionDescriptions for group
policy_ids
optional
arrayGroup Policy ID List37f2e31ff86b415698d7e8eeafab445d
tags
optional
arrayGroup Tag{'key': 'company', 'value': 'SDS'}
user_ids
optional
arrayGroup Member User ID Listf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.6.3 - 1.1

scpcli iam group create
--name <value>
--description <value>
[--policy_ids <value>]
[--tags <value>]
[--user_ids <value>]

Description

Create a group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
name
required
stringGroup NameTestGroup
description
required
stringGroup DescriptionDescriptions for group
policy_ids
optional
arrayGroup Policy ID List37f2e31ff86b415698d7e8eeafab445d
tags
optional
arrayGroup Tag{'key': 'company', 'value': 'SDS'}
user_ids
optional
arrayGroup Member User ID Listf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.6.4 - 1.0

scpcli iam group create
--name <value>
--description <value>
[--policy_ids <value>]
[--tags <value>]
[--user_ids <value>]

Description

Create a group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
name
required
stringGroup NameTestGroup
description
required
stringGroup DescriptionDescriptions for group
policy_ids
optional
arrayGroup Policy ID List37f2e31ff86b415698d7e8eeafab445d
tags
optional
arrayGroup Tag{'key': 'company', 'value': 'SDS'}
user_ids
optional
arrayGroup Member User ID Listf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.7 - Create a policy

3.1.7.1 - 1.3

scpcli iam policy create
--version <value>
--statement <value>
--policy_name <value>
[--default_version_id <value>]
[--description <value>]
[--policy_category <value>]
[--policy_type <value>]
[--service_type <value>]
[--tags <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Create a policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_name
required
stringPolicy NamePolicyName
default_version_id
optional
stringDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_category
optional
stringPolicy CategoryIDENTITY_BASED
policy_type
optional
stringPolicy TypeUSER_DEFINED
service_type
optional
stringService Typescp-iam
tags
optional
arrayPolicy Tag{'key': 'foo', 'value': 'bar'}
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

3.1.7.2 - 1.2

scpcli iam policy create
--version <value>
--statement <value>
--policy_name <value>
[--default_version_id <value>]
[--description <value>]
[--policy_category <value>]
[--policy_type <value>]
[--service_type <value>]
[--tags <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Create a policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_name
required
stringPolicy NamePolicyName
default_version_id
optional
stringDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_category
optional
stringPolicy CategoryIDENTITY_BASED
policy_type
optional
stringPolicy TypeUSER_DEFINED
service_type
optional
stringService Typescp-iam
tags
optional
arrayPolicy Tag{'key': 'foo', 'value': 'bar'}
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

3.1.7.3 - 1.1

scpcli iam policy create
--version <value>
--statement <value>
--policy_name <value>
[--default_version_id <value>]
[--description <value>]
[--policy_category <value>]
[--policy_type <value>]
[--service_type <value>]
[--tags <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Create a policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_name
required
stringPolicy NamePolicyName
default_version_id
optional
stringDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_category
optional
stringPolicy CategoryIDENTITY_BASED
policy_type
optional
stringPolicy TypeUSER_DEFINED
service_type
optional
stringService Typescp-iam
tags
optional
arrayPolicy Tag{'key': 'foo', 'value': 'bar'}
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

3.1.7.4 - 1.0

scpcli iam policy create
--version <value>
--statement <value>
--policy_name <value>
[--default_version_id <value>]
[--description <value>]
[--policy_category <value>]
[--policy_type <value>]
[--service_type <value>]
[--tags <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Create a policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_name
required
stringPolicy NamePolicyName
default_version_id
optional
stringDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_category
optional
stringPolicy CategoryIDENTITY_BASED
policy_type
optional
stringPolicy TypeUSER_DEFINED
service_type
optional
stringService Typescp-iam
tags
optional
arrayPolicy Tag{'key': 'foo', 'value': 'bar'}
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

3.1.8 - Create a saml provider

3.1.8.1 - 1.3

scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]

Description

Create a saml provider

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
saml_provider_name
required
stringCredential Provider NameIdpTest
federation_type
required
stringCredential Provider TypeSAML
description
optional
stringCredential Provider DescriptionSAML provider Description
file
optional
stringMetadata Filekeycloak-idp-saml.xml
tags
optional
arrayTags{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
idp_cert_endValidity Period
idp_file_nameMetadata File Name
idp_file_sizeMetadata File Size
idp_issuer_urlIssuer URL
idp_sso_urlSSO Service Location
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.8.2 - 1.2

scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]

Description

Create a saml provider

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
saml_provider_name
required
stringCredential Provider NameIdpTest
federation_type
required
stringCredential Provider TypeSAML
description
optional
stringCredential Provider DescriptionSAML provider Description
file
optional
stringMetadata Filekeycloak-idp-saml.xml
tags
optional
arrayTags{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
idp_cert_endValidity Period
idp_file_nameMetadata File Name
idp_file_sizeMetadata File Size
idp_issuer_urlIssuer URL
idp_sso_urlSSO Service Location
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.8.3 - 1.1

scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]

Description

Create a saml provider

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
saml_provider_name
required
stringCredential Provider NameIdpTest
federation_type
required
stringCredential Provider TypeSAML
description
optional
stringCredential Provider DescriptionSAML provider Description
file
optional
stringMetadata Filekeycloak-idp-saml.xml
tags
optional
arrayTags{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
idp_cert_endValidity Period
idp_file_nameMetadata File Name
idp_file_sizeMetadata File Size
idp_issuer_urlIssuer URL
idp_sso_urlSSO Service Location
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.8.4 - 1.0

scpcli iam saml provider create
--saml_provider_name <value>
--federation_type <value>
[--description <value>]
[--file <value>]
[--tags <value>]

Description

Create a saml provider

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
saml_provider_name
required
stringCredential Provider NameIdpTest
federation_type
required
stringCredential Provider TypeSAML
description
optional
stringCredential Provider DescriptionSAML provider Description
file
optional
stringMetadata Filekeycloak-idp-saml.xml
tags
optional
arrayTags{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
idp_cert_endValidity Period
idp_file_nameMetadata File Name
idp_file_sizeMetadata File Size
idp_issuer_urlIssuer URL
idp_sso_urlSSO Service Location
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.9 - Create an access key

3.1.9.1 - 1.3

scpcli iam access-key create
--access_key_type <value>
[--account_id <value>]
[--description <value>]
[--duration <value>]
[--parent_access_key_id <value>]
[--passcode <value>]

Description

Create an access key

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
access_key_type
required
stringAccess Key TypePERMANENT
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
description
optional
stringDescriptiondescription
duration
optional
stringExpiration DurationP1Y2M10DT2H30M15S
parent_access_key_id
optional
stringRequired Access Key for Creating Temporary Access Key92d6eid9e9ae4f868s842910k11573a3
passcode
optional
stringRequired for Temporary Access Key000000

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.9.2 - 1.2

scpcli iam access-key create
--access_key_type <value>
[--account_id <value>]
[--description <value>]
[--duration <value>]
[--parent_access_key_id <value>]
[--passcode <value>]

Description

Create an access key

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
access_key_type
required
stringAccess Key TypePERMANENT
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
description
optional
stringDescriptiondescription
duration
optional
stringExpiration DurationP1Y2M10DT2H30M15S
parent_access_key_id
optional
stringRequired Access Key for Creating Temporary Access Key92d6eid9e9ae4f868s842910k11573a3
passcode
optional
stringRequired for Temporary Access Key000000

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.9.3 - 1.1

scpcli iam access-key create
--access_key_type <value>
[--account_id <value>]
[--description <value>]
[--duration <value>]
[--parent_access_key_id <value>]
[--passcode <value>]

Description

Create an access key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
access_key_type
required
stringAccess Key TypePERMANENT
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
description
optional
stringDescriptiondescription
duration
optional
stringExpiration DurationP1Y2M10DT2H30M15S
parent_access_key_id
optional
stringRequired Access Key for Creating Temporary Access Key92d6eid9e9ae4f868s842910k11573a3
passcode
optional
stringRequired for Temporary Access Key000000

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.9.4 - 1.0

scpcli iam access-key create
--access_key_type <value>
[--account_id <value>]
[--description <value>]
[--duration <value>]
[--parent_access_key_id <value>]
[--passcode <value>]

Description

Create an access key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
access_key_type
required
stringAccess Key TypePERMANENT
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
description
optional
stringDescriptiondescription
duration
optional
stringExpiration DurationP1Y2M10DT2H30M15S
parent_access_key_id
optional
stringRequired Access Key for Creating Temporary Access Key92d6eid9e9ae4f868s842910k11573a3
passcode
optional
stringRequired for Temporary Access Key000000

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.10 - Create IAM user

3.1.10.1 - 1.3

scpcli iam iam user create
--account_id <value>
--user_name <value>
--temporary_password <value>
--password <value>
[--description <value>]
[--group_ids <value>]
[--policy_ids <value>]
[--tags <value>]

Description

Create IAM user

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
user_name
required
stringUser Name-
temporary_password
required
booleanTemporary-
password
required
stringPassword-
description
optional
stringUser Description-
group_ids
optional
arrayGroup IDs-
policy_ids
optional
arrayPolicy IDs Field-
tags
optional
arrayUser Tag-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.10.2 - 1.2

scpcli iam iam user create
--account_id <value>
--user_name <value>
--temporary_password <value>
--password <value>
[--description <value>]
[--group_ids <value>]
[--policy_ids <value>]
[--tags <value>]

Description

Create IAM user

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
user_name
required
stringUser Name-
temporary_password
required
booleanTemporary-
password
required
stringPassword-
description
optional
stringUser Description-
group_ids
optional
arrayGroup IDs-
policy_ids
optional
arrayPolicy IDs Field-
tags
optional
arrayUser Tag-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.10.3 - 1.1

scpcli iam iam user create
--account_id <value>
--user_name <value>
--temporary_password <value>
--password <value>
[--description <value>]
[--group_ids <value>]
[--policy_ids <value>]
[--tags <value>]

Description

Create IAM user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
user_name
required
stringUser Name-
temporary_password
required
booleanTemporary-
password
required
stringPassword-
description
optional
stringUser Description-
group_ids
optional
arrayGroup IDs-
policy_ids
optional
arrayPolicy IDs Field-
tags
optional
arrayUser Tag-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.10.4 - 1.0

scpcli iam iam user create
--account_id <value>
--user_name <value>
--temporary_password <value>
--password <value>
[--description <value>]
[--group_ids <value>]
[--policy_ids <value>]
[--tags <value>]

Description

Create IAM user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
user_name
required
stringUser Name-
temporary_password
required
booleanTemporary-
password
required
stringPassword-
description
optional
stringUser Description-
group_ids
optional
arrayGroup IDs-
policy_ids
optional
arrayPolicy IDs Field-
tags
optional
arrayUser Tag-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.11 - Create role

3.1.11.1 - 1.3

scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--role_type <value>]
[--tags <value>]

Description

Create role

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_ids
required
arrayPolicy ID List to Attach to Role37f2e31ff86b415698d7e8eeafab445d
name
required
stringRole Name-
account_id
optional
stringAccount ID-
description
optional
stringRole Description-
max_session_duration
optional
integerRole Maximum Session Duration (seconds)3600
principals
optional
arrayTrust Policy Principal List'{"type": "", "value": ""}'
role_type
optional
stringRole Type-
tags
optional
arrayRole Tag{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.11.2 - 1.2

scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]

Description

Create role

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_ids
required
arrayPolicy ID List to Attach to Role37f2e31ff86b415698d7e8eeafab445d
name
required
stringRole Name-
account_id
optional
stringAccount ID-
description
optional
stringRole Description-
max_session_duration
optional
integerRole Maximum Session Duration (seconds)3600
principals
optional
arrayTrust Policy Principal List'{"type": "", "value": ""}'
tags
optional
arrayRole Tag{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.11.3 - 1.1

scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]

Description

Create role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_ids
required
arrayPolicy ID List to Attach to Role37f2e31ff86b415698d7e8eeafab445d
name
required
stringRole Name-
account_id
optional
stringAccount ID-
description
optional
stringRole Description-
max_session_duration
optional
integerRole Maximum Session Duration (seconds)3600
principals
optional
arrayTrust Policy Principal List'{"type": "", "value": ""}'
tags
optional
arrayRole Tag{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.11.4 - 1.0

scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]

Description

Create role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_ids
required
arrayPolicy ID List to Attach to Role37f2e31ff86b415698d7e8eeafab445d
name
required
stringRole Name-
account_id
optional
stringAccount ID-
description
optional
stringRole Description-
max_session_duration
optional
integerRole Maximum Session Duration (seconds)3600
principals
optional
arrayTrust Policy Principal List'{"type": "", "value": ""}'
tags
optional
arrayRole Tag{'key': 'company', 'value': 'SDS'}

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.12 - Delete bulk role

3.1.12.1 - 1.3

scpcli iam role bulk delete
[--account_id <value>]
[--role_ids <value>]
[--role_names <value>]

Description

Delete bulk role

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
account_id
optional
stringAccount ID-
role_ids
optional
arrayRole ID List-
role_names
optional
arrayRole Name List-

3.1.12.2 - 1.2

scpcli iam role bulk delete
[--account_id <value>]
[--role_ids <value>]
[--role_names <value>]

Description

Delete bulk role

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
account_id
optional
stringAccount ID-
role_ids
optional
arrayRole ID List-
role_names
optional
arrayRole Name List-

3.1.12.3 - 1.1

scpcli iam role bulk delete
[--account_id <value>]
[--role_ids <value>]
[--role_names <value>]

Description

Delete bulk role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
account_id
optional
stringAccount ID-
role_ids
optional
arrayRole ID List-
role_names
optional
arrayRole Name List-

3.1.12.4 - 1.0

scpcli iam role bulk delete
[--account_id <value>]
[--role_ids <value>]
[--role_names <value>]

Description

Delete bulk role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
account_id
optional
stringAccount ID-
role_ids
optional
arrayRole ID List-
role_names
optional
arrayRole Name List-

3.1.13 - Delete IAM user

3.1.13.1 - 1.3

scpcli iam iam user delete
--user_id <value>
--account_id <value>

Description

Delete IAM user

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-

3.1.13.2 - 1.2

scpcli iam iam user delete
--user_id <value>
--account_id <value>

Description

Delete IAM user

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-

3.1.13.3 - 1.1

scpcli iam iam user delete
--user_id <value>
--account_id <value>

Description

Delete IAM user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-

3.1.14 - Delete IAM users

3.1.14.1 - 1.3

scpcli iam iam user bulk delete
--account_id <value>
[--user_ids <value>]

Description

Delete IAM users

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
user_ids
optional
arrayUser ID List-

3.1.14.2 - 1.2

scpcli iam iam user bulk delete
--account_id <value>
[--user_ids <value>]

Description

Delete IAM users

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
user_ids
optional
arrayUser ID List-

3.1.14.3 - 1.1

scpcli iam iam user bulk delete
--account_id <value>
[--user_ids <value>]

Description

Delete IAM users

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
user_ids
optional
arrayUser ID List-

3.1.14.4 - 1.0

scpcli iam iam user bulk delete
--account_id <value>
[--user_ids <value>]

Description

Delete IAM users

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
user_ids
optional
arrayUser ID List-

3.1.15 - Delete role

3.1.15.1 - 1.3

scpcli iam role delete
--role_id <value>

Description

Delete role

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-

3.1.15.2 - 1.2

scpcli iam role delete
--role_id <value>

Description

Delete role

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-

3.1.15.3 - 1.1

scpcli iam role delete
--role_id <value>

Description

Delete role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-

3.1.15.4 - 1.0

scpcli iam role delete
--role_id <value>

Description

Delete role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-

3.1.16 - Delete the policy

3.1.16.1 - 1.3

scpcli iam policy delete
--policy_id <value>

Description

Delete the policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

3.1.16.2 - 1.2

scpcli iam policy delete
--policy_id <value>

Description

Delete the policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

3.1.16.3 - 1.1

scpcli iam policy delete
--policy_id <value>

Description

Delete the policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

3.1.16.4 - 1.0

scpcli iam policy delete
--policy_id <value>

Description

Delete the policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

3.1.17 - Delete the resource based policy

3.1.17.1 - 1.3

scpcli iam resource policy delete
--srn <value>

Description

Delete the resource based policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

3.1.17.2 - 1.2

scpcli iam resource policy delete
--srn <value>

Description

Delete the resource based policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

3.1.17.3 - 1.1

scpcli iam resource policy delete
--srn <value>

Description

Delete the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

3.1.17.4 - 1.0

scpcli iam resource policy delete
--srn <value>

Description

Delete the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

3.1.18 - Delete user policy

3.1.18.1 - 1.3

scpcli iam user policy delete
--policy_id <value>
--user_id <value>

Description

Delete user policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID-
user_id
required
stringUser ID-

3.1.18.2 - 1.2

scpcli iam user policy delete
--policy_id <value>
--user_id <value>

Description

Delete user policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID-
user_id
required
stringUser ID-

3.1.18.3 - 1.1

scpcli iam user policy delete
--policy_id <value>
--user_id <value>

Description

Delete user policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID-
user_id
required
stringUser ID-

3.1.18.4 - 1.0

scpcli iam user policy delete
--policy_id <value>
--user_id <value>

Description

Delete user policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID-
user_id
required
stringUser ID-

3.1.19 - Detach policies to Role

3.1.19.1 - 1.3

scpcli iam role policy binding bulk detach
--role_id <value>
--policy_ids <value>

Description

Detach policies to Role

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
policy_ids
required
arrayPolicy ID List to Attach to Role-

3.1.19.2 - 1.2

scpcli iam role policy binding bulk detach
--role_id <value>
--policy_ids <value>

Description

Detach policies to Role

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
policy_ids
required
arrayPolicy ID List to Attach to Role-

3.1.19.3 - 1.1

scpcli iam role policy binding bulk detach
--role_id <value>
--policy_ids <value>

Description

Detach policies to Role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
policy_ids
required
arrayPolicy ID List to Attach to Role-

3.1.19.4 - 1.0

scpcli iam role policy binding bulk detach
--role_id <value>
--policy_ids <value>

Description

Detach policies to Role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
policy_ids
required
arrayPolicy ID List to Attach to Role-

3.1.20 - Detach policy to Role

3.1.20.1 - 1.3

scpcli iam role policy binding detach
--policy_id <value>
--role_id <value>

Description

Detach policy to Role

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID Attached to Role-
role_id
required
stringRole ID-

3.1.20.2 - 1.2

scpcli iam role policy binding detach
--policy_id <value>
--role_id <value>

Description

Detach policy to Role

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID Attached to Role-
role_id
required
stringRole ID-

3.1.20.3 - 1.1

scpcli iam role policy binding detach
--policy_id <value>
--role_id <value>

Description

Detach policy to Role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID Attached to Role-
role_id
required
stringRole ID-

3.1.20.4 - 1.0

scpcli iam role policy binding detach
--policy_id <value>
--role_id <value>

Description

Detach policy to Role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID Attached to Role-
role_id
required
stringRole ID-

3.1.21 - Get a Group

3.1.21.1 - 1.3

scpcli iam group show
--group_id <value>

Description

Get a Group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.21.2 - 1.2

scpcli iam group show
--group_id <value>

Description

Get a Group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.21.3 - 1.1

scpcli iam group show
--group_id <value>

Description

Get a Group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.21.4 - 1.0

scpcli iam group show
--group_id <value>

Description

Get a Group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.22 - Get a specific policy binding list

3.1.22.1 - 1.3

scpcli iam policy binding list
--policy_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--identity_id <value>]
[--identity_type <value>]
[--name <value>]

Description

Get a specific policy binding list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
identity_id
optional
stringIdentity IDf39c460fade34fecb05ede8f904b24b7
identity_type
optional
stringIdentity TypeGROUP
name
optional
stringNameTestGroup

Responses

NameDescriptionExample
countcount20
groupsGroup[{‘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’}]
pagepage0
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
rolesRole[{‘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’}]
sizesize20
sortsort[‘created_at:asc’]
usersUser[{‘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’}]

3.1.22.2 - 1.2

scpcli iam policy binding list
--policy_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--identity_id <value>]
[--identity_type <value>]
[--name <value>]

Description

Get a specific policy binding list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
identity_id
optional
stringIdentity IDf39c460fade34fecb05ede8f904b24b7
identity_type
optional
stringIdentity TypeGROUP
name
optional
stringNameTestGroup

Responses

NameDescriptionExample
countcount20
groupsGroup[{‘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’}]
pagepage0
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
rolesRole[{‘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’}]
sizesize20
sortsort[‘created_at:asc’]
usersUser[{‘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’}]

3.1.22.3 - 1.1

scpcli iam policy binding list
--policy_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--identity_id <value>]
[--identity_type <value>]
[--name <value>]

Description

Get a specific policy binding list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
identity_id
optional
stringIdentity IDf39c460fade34fecb05ede8f904b24b7
identity_type
optional
stringIdentity TypeGROUP
name
optional
stringNameTestGroup

Responses

NameDescriptionExample
countcount20
groupsGroup[{‘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’}]
pagepage0
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
rolesRole[{‘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’}]
sizesize20
sortsort[‘created_at:asc’]
usersUser[{‘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’}]

3.1.22.4 - 1.0

scpcli iam policy binding list
--policy_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--identity_id <value>]
[--identity_type <value>]
[--name <value>]

Description

Get a specific policy binding list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
identity_id
optional
stringIdentity IDf39c460fade34fecb05ede8f904b24b7
identity_type
optional
stringIdentity TypeGROUP
name
optional
stringNameTestGroup

Responses

NameDescriptionExample
countcount20
groupsGroup[{‘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’}]
pagepage0
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
rolesRole[{‘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’}]
sizesize20
sortsort[‘created_at:asc’]
usersUser[{‘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’}]

3.1.23 - Get an access key

3.1.23.1 - 1.3

scpcli iam access-key show
--access_key_id <value>

Description

Get an access key

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.23.2 - 1.2

scpcli iam access-key show
--access_key_id <value>

Description

Get an access key

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.23.3 - 1.1

scpcli iam access-key show
--access_key_id <value>

Description

Get an access key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.23.4 - 1.0

scpcli iam access-key show
--access_key_id <value>

Description

Get an access key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.24 - Get endpoint list

3.1.24.1 - 1.3

scpcli iam endpoint list

Description

Get endpoint list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Responses

NameDescriptionExample
regionRegionkr-west1
service_nameService Namescp-iam
service_typeService Typescp-iam
urlURLhttps://iam.dev2.samsungsdscloud.com

3.1.24.2 - 1.2

scpcli iam endpoint list

Description

Get endpoint list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Responses

NameDescriptionExample
regionRegionkr-west1
service_nameService Namescp-iam
service_typeService Typescp-iam
urlURLhttps://iam.dev2.samsungsdscloud.com

3.1.24.3 - 1.1

scpcli iam endpoint list

Description

Get endpoint list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Responses

NameDescriptionExample
regionRegionkr-west1
service_nameService Namescp-iam
service_typeService Typescp-iam
urlURLhttps://iam.dev2.samsungsdscloud.com

3.1.24.4 - 1.0

scpcli iam endpoint list

Description

Get endpoint list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Responses

NameDescriptionExample
regionRegionkr-west1
service_nameService Namescp-iam
service_typeService Typescp-iam
urlURLhttps://iam.dev2.samsungsdscloud.com

3.1.25 - Get IAM users

3.1.25.1 - 1.3

scpcli iam iam user show
--user_id <value>
--account_id <value>

Description

Get IAM users

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.25.2 - 1.2

scpcli iam iam user show
--user_id <value>
--account_id <value>

Description

Get IAM users

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.25.3 - 1.1

scpcli iam iam user show
--user_id <value>
--account_id <value>

Description

Get IAM users

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.25.4 - 1.0

scpcli iam iam user show
--user_id <value>
--account_id <value>

Description

Get IAM users

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.26 - Get policy list

3.1.26.1 - 1.3

scpcli iam policy list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]

Description

Get policy list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringCreator Last Name, First Nametest1
creator_email
optional
stringCreator Emailtest@test.com
modifier_name
optional
stringModifier Last Name, First Nametest1
modifier_email
optional
stringModifier Emailtest@test.com
exclude_group_id
optional
stringGroup ID to Excludea946662dc4314dac93da413a32457459
exclude_user_id
optional
stringUser ID to Exclude-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.26.2 - 1.2

scpcli iam policy list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]

Description

Get policy list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringCreator Last Name, First Nametest1
creator_email
optional
stringCreator Emailtest@test.com
modifier_name
optional
stringModifier Last Name, First Nametest1
modifier_email
optional
stringModifier Emailtest@test.com
exclude_group_id
optional
stringGroup ID to Excludea946662dc4314dac93da413a32457459
exclude_user_id
optional
stringUser ID to Exclude-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.26.3 - 1.1

scpcli iam policy list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]

Description

Get policy list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringCreator Last Name, First Nametest1
creator_email
optional
stringCreator Emailtest@test.com
modifier_name
optional
stringModifier Last Name, First Nametest1
modifier_email
optional
stringModifier Emailtest@test.com
exclude_group_id
optional
stringGroup ID to Excludea946662dc4314dac93da413a32457459
exclude_user_id
optional
stringUser ID to Exclude-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.26.4 - 1.0

scpcli iam policy list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]

Description

Get policy list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringCreator Last Name, First Nametest1
creator_email
optional
stringCreator Emailtest@test.com
modifier_name
optional
stringModifier Last Name, First Nametest1
modifier_email
optional
stringModifier Emailtest@test.com
exclude_group_id
optional
stringGroup ID to Excludea946662dc4314dac93da413a32457459
exclude_user_id
optional
stringUser ID to Exclude-

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.27 - Get role

3.1.27.1 - 1.3

scpcli iam role show
--role_id <value>

Description

Get role

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.27.2 - 1.2

scpcli iam role show
--role_id <value>

Description

Get role

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.27.3 - 1.1

scpcli iam role show
--role_id <value>

Description

Get role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.27.4 - 1.0

scpcli iam role show
--role_id <value>

Description

Get role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.28 - Get role list

3.1.28.1 - 1.3

scpcli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]

Description

Get role list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringRole Name-
role_type
optional
stringRole Type-
account_id
optional
stringAccount ID-
exclude_policy_id
optional
stringPolicy Exception-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.28.2 - 1.2

scpcli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]

Description

Get role list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringRole Name-
role_type
optional
stringRole Type-
account_id
optional
stringAccount ID-
exclude_policy_id
optional
stringPolicy Exception-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.28.3 - 1.1

scpcli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]

Description

Get role list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringRole Name-
role_type
optional
stringRole Type-
account_id
optional
stringAccount ID-
exclude_policy_id
optional
stringPolicy Exception-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.28.4 - 1.0

scpcli iam role list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--role_type <value>]
[--account_id <value>]
[--exclude_policy_id <value>]

Description

Get role list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringRole Name-
role_type
optional
stringRole Type-
account_id
optional
stringAccount ID-
exclude_policy_id
optional
stringPolicy Exception-

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
account_idAccount ID
assume_role_policy_documentRole Trust Policy
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Email
creator_nameCreator Last Name, First Name
descriptionRole Description
max_session_durationRole Maximum Session Duration (seconds)
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Email
modifier_nameModifier Last Name, First Name
nameRole Name
policiesPolicy List Attached to Role
typeRole Type

3.1.29 - Get Role Policy-Binding list

3.1.29.1 - 1.3

scpcli iam role policy binding list
--role_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get Role Policy-Binding list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID Attached to Role-
policy_name
optional
stringPolicy Name Attached to Role-
policy_type
optional
stringPolicy Type List Attached to Role['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.29.2 - 1.2

scpcli iam role policy binding list
--role_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get Role Policy-Binding list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID Attached to Role-
policy_name
optional
stringPolicy Name Attached to Role-
policy_type
optional
stringPolicy Type List Attached to Role['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.29.3 - 1.1

scpcli iam role policy binding list
--role_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get Role Policy-Binding list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID Attached to Role-
policy_name
optional
stringPolicy Name Attached to Role-
policy_type
optional
stringPolicy Type List Attached to Role['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.29.4 - 1.0

scpcli iam role policy binding list
--role_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get Role Policy-Binding list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID Attached to Role-
policy_name
optional
stringPolicy Name Attached to Role-
policy_type
optional
stringPolicy Type List Attached to Role['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.30 - Get saml provider information

3.1.30.1 - 1.3

scpcli iam saml provider show
--saml_provider_id <value>

Description

Get saml provider information

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
saml_provider_id
required
stringCredential Provider ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
idp_cert_endValidity Period
idp_file_dataMetadata Content
idp_file_nameMetadata File Name
idp_file_sizeMetadata File Size
idp_issuer_urlIssuer URL
idp_sso_urlSSO Service Location
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.30.2 - 1.2

scpcli iam saml provider show
--saml_provider_id <value>

Description

Get saml provider information

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
saml_provider_id
required
stringCredential Provider ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
idp_cert_endValidity Period
idp_file_dataMetadata Content
idp_file_nameMetadata File Name
idp_file_sizeMetadata File Size
idp_issuer_urlIssuer URL
idp_sso_urlSSO Service Location
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.30.3 - 1.1

scpcli iam saml provider show
--saml_provider_id <value>

Description

Get saml provider information

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
saml_provider_id
required
stringCredential Provider ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
idp_cert_endValidity Period
idp_file_dataMetadata Content
idp_file_nameMetadata File Name
idp_file_sizeMetadata File Size
idp_issuer_urlIssuer URL
idp_sso_urlSSO Service Location
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.30.4 - 1.0

scpcli iam saml provider show
--saml_provider_id <value>

Description

Get saml provider information

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
saml_provider_id
required
stringCredential Provider ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
acs_urlACS URL
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
idp_cert_endValidity Period
idp_file_dataMetadata Content
idp_file_nameMetadata File Name
idp_file_sizeMetadata File Size
idp_issuer_urlIssuer URL
idp_sso_urlSSO Service Location
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.31 - Get service account

3.1.31.1 - 1.3

scpcli iam service account show
--service_account_id <value>

Description

Get service account

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
service_account_id
required
stringService Account ID-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
passwordService Account’s Password
serviceService Account’s Service

3.1.31.2 - 1.2

scpcli iam service account show
--service_account_id <value>

Description

Get service account

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
service_account_id
required
stringService Account ID-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
passwordService Account’s Password
serviceService Account’s Service

3.1.31.3 - 1.1

scpcli iam service account show
--service_account_id <value>

Description

Get service account

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
service_account_id
required
stringService Account ID-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
passwordService Account’s Password
serviceService Account’s Service

3.1.31.4 - 1.0

scpcli iam service account show
--service_account_id <value>

Description

Get service account

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
service_account_id
required
stringService Account ID-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
passwordService Account’s Password
serviceService Account’s Service

3.1.32 - Get user policy-binding list

3.1.32.1 - 1.3

scpcli iam user policy show
--user_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get user policy-binding list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID-
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type List['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.32.2 - 1.2

scpcli iam user policy show
--user_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get user policy-binding list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID-
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type List['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.32.3 - 1.1

scpcli iam user policy show
--user_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get user policy-binding list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID-
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type List['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.32.4 - 1.0

scpcli iam user policy show
--user_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Get user policy-binding list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID-
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type List['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.33 - Group Member list

3.1.33.1 - 1.3

scpcli iam group user list
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]
[--user_email <value>]
[--creator_name <value>]
[--creator_email <value>]

Description

Group Member list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_name
optional
stringGroup Member Last Name, First NameKim Samsung
user_email
optional
stringGroup Member Emailsamsung.kim@samsung.com
creator_name
optional
stringCreator Last Name, First NameKim Samsung
creator_email
optional
stringCreator Emailsamsung.kim@samsung.com

Responses

NameDescriptionExample
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_created_atCreated At2024-05-17T00:23:17Z
creator_emailCreator Emailsamsung.kim@samsung.com
creator_last_login_atGroup Member Last Login At2024-05-17T00:23:17Z
creator_nameCreator Last Name, First NameKim Samsung
group_namesGroup Names[‘TestGroup’, ‘SampleGroup’]
user_created_atCreated At2024-05-17T00:23:17Z
user_emailGroup Member Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_last_login_atGroup Member Last Login At2024-05-17T00:23:17Z
user_nameGroup Member Last Name, First NameKim Samsung

3.1.33.2 - 1.2

scpcli iam group user list
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]
[--user_email <value>]
[--creator_name <value>]
[--creator_email <value>]

Description

Group Member list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_name
optional
stringGroup Member Last Name, First NameKim Samsung
user_email
optional
stringGroup Member Emailsamsung.kim@samsung.com
creator_name
optional
stringCreator Last Name, First NameKim Samsung
creator_email
optional
stringCreator Emailsamsung.kim@samsung.com

Responses

NameDescriptionExample
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_created_atCreated At2024-05-17T00:23:17Z
creator_emailCreator Emailsamsung.kim@samsung.com
creator_last_login_atGroup Member Last Login At2024-05-17T00:23:17Z
creator_nameCreator Last Name, First NameKim Samsung
group_namesGroup Names[‘TestGroup’, ‘SampleGroup’]
user_created_atCreated At2024-05-17T00:23:17Z
user_emailGroup Member Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_last_login_atGroup Member Last Login At2024-05-17T00:23:17Z
user_nameGroup Member Last Name, First NameKim Samsung

3.1.33.3 - 1.1

scpcli iam group user list
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]
[--user_email <value>]
[--creator_name <value>]
[--creator_email <value>]

Description

Group Member list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_name
optional
stringGroup Member Last Name, First NameKim Samsung
user_email
optional
stringGroup Member Emailsamsung.kim@samsung.com
creator_name
optional
stringCreator Last Name, First NameKim Samsung
creator_email
optional
stringCreator Emailsamsung.kim@samsung.com

Responses

NameDescriptionExample
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_created_atCreated At2024-05-17T00:23:17Z
creator_emailCreator Emailsamsung.kim@samsung.com
creator_last_login_atGroup Member Last Login At2024-05-17T00:23:17Z
creator_nameCreator Last Name, First NameKim Samsung
group_namesGroup Names[‘TestGroup’, ‘SampleGroup’]
user_created_atCreated At2024-05-17T00:23:17Z
user_emailGroup Member Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_last_login_atGroup Member Last Login At2024-05-17T00:23:17Z
user_nameGroup Member Last Name, First NameKim Samsung

3.1.33.4 - 1.0

scpcli iam group user list
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_name <value>]
[--user_email <value>]
[--creator_name <value>]
[--creator_email <value>]

Description

Group Member list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_name
optional
stringGroup Member Last Name, First NameKim Samsung
user_email
optional
stringGroup Member Emailsamsung.kim@samsung.com
creator_name
optional
stringCreator Last Name, First NameKim Samsung
creator_email
optional
stringCreator Emailsamsung.kim@samsung.com

Responses

NameDescriptionExample
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_created_atCreated At2024-05-17T00:23:17Z
creator_emailCreator Emailsamsung.kim@samsung.com
creator_last_login_atGroup Member Last Login At2024-05-17T00:23:17Z
creator_nameCreator Last Name, First NameKim Samsung
group_namesGroup Names[‘TestGroup’, ‘SampleGroup’]
user_created_atCreated At2024-05-17T00:23:17Z
user_emailGroup Member Emailsamsung.kim@samsung.com
user_idUser IDf39c460fade34fecb05ede8f904b24b7
user_last_login_atGroup Member Last Login At2024-05-17T00:23:17Z
user_nameGroup Member Last Name, First NameKim Samsung

3.1.34 - List access keys

3.1.34.1 - 1.3

scpcli iam access-key list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--access_key_type <value>]
[--parent_access_key_id <value>]

Description

List access keys

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
access_key_type
optional
stringAccess Key TypePERMANENT
parent_access_key_id
optional
stringParent Access Key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.34.2 - 1.2

scpcli iam access-key list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--access_key_type <value>]
[--parent_access_key_id <value>]

Description

List access keys

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
access_key_type
optional
stringAccess Key TypePERMANENT
parent_access_key_id
optional
stringParent Access Key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.34.3 - 1.1

scpcli iam access-key list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--access_key_type <value>]
[--parent_access_key_id <value>]

Description

List access keys

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
access_key_type
optional
stringAccess Key TypePERMANENT
parent_access_key_id
optional
stringParent Access Key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.34.4 - 1.0

scpcli iam access-key list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--access_key_type <value>]
[--parent_access_key_id <value>]

Description

List access keys

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount Idf39c460fade34fecb05ede8f904b24b7
access_key_type
optional
stringAccess Key TypePERMANENT
parent_access_key_id
optional
stringParent Access Key IDf39c460fade34fecb05ede8f904b24b7

Responses

NameDescriptionExample
idID6558fc9df5b54c8a985465bdf637e097
access_keyAccess Keyb754b12b39da4ce29a40c5e324650bd0
access_key_typeAccess Key TypePERMANENT
account_idAccount Idf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptiondescription
expiration_timestampAccess Key Expiration Timestamp9999-12-31T23:59:59Z
is_enabledActivation Statustrue
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
parent_access_key_idParent Access Key ID Used for Temporary Access Key Creation92d6eid9e9ae4f868s842910k11573a3
secret_keySecret Keyc4150149-f7c6-46bc-9faa-d2b9d20e0899

3.1.35 - List Groups

3.1.35.1 - 1.3

scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]

Description

List Groups

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup NameTestGroup
types
optional
stringGroup TypesUSER_DEFINED,DEFAULT
ids
optional
stringGroup ID List629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765
has_member
optional
stringGroup Member Existencefalse
has_role
optional
stringGroup Role Existencefalse
is_completed
optional
stringGroup Completion Statusfalse
creator_name
optional
stringCreator Last Name, First NameKim Samsung
creator_email
optional
stringCreator Emailsamsung.kim@samsung.com
modifier_name
optional
stringModifier Last Name, First NameKim Samsung
modifier_email
optional
stringModifier Emailsamsung.kim@samsung.com
exclude_user_id
optional
stringUser ID to Excludef39c460fade34fecb05ede8f904b24b7
exclude_policy_id
optional
stringPolicy ID to Exclude37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.35.2 - 1.2

scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]

Description

List Groups

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup NameTestGroup
types
optional
stringGroup TypesUSER_DEFINED,DEFAULT
ids
optional
stringGroup ID List629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765
has_member
optional
stringGroup Member Existencefalse
has_role
optional
stringGroup Role Existencefalse
is_completed
optional
stringGroup Completion Statusfalse
creator_name
optional
stringCreator Last Name, First NameKim Samsung
creator_email
optional
stringCreator Emailsamsung.kim@samsung.com
modifier_name
optional
stringModifier Last Name, First NameKim Samsung
modifier_email
optional
stringModifier Emailsamsung.kim@samsung.com
exclude_user_id
optional
stringUser ID to Excludef39c460fade34fecb05ede8f904b24b7
exclude_policy_id
optional
stringPolicy ID to Exclude37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.35.3 - 1.1

scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]

Description

List Groups

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup NameTestGroup
types
optional
stringGroup TypesUSER_DEFINED,DEFAULT
ids
optional
stringGroup ID List629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765
has_member
optional
stringGroup Member Existencefalse
has_role
optional
stringGroup Role Existencefalse
is_completed
optional
stringGroup Completion Statusfalse
creator_name
optional
stringCreator Last Name, First NameKim Samsung
creator_email
optional
stringCreator Emailsamsung.kim@samsung.com
modifier_name
optional
stringModifier Last Name, First NameKim Samsung
modifier_email
optional
stringModifier Emailsamsung.kim@samsung.com
exclude_user_id
optional
stringUser ID to Excludef39c460fade34fecb05ede8f904b24b7
exclude_policy_id
optional
stringPolicy ID to Exclude37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.35.4 - 1.0

scpcli iam group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--types <value>]
[--ids <value>]
[--has_member <value>]
[--has_role <value>]
[--is_completed <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_user_id <value>]
[--exclude_policy_id <value>]

Description

List Groups

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup NameTestGroup
types
optional
stringGroup TypesUSER_DEFINED,DEFAULT
ids
optional
stringGroup ID List629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765
has_member
optional
stringGroup Member Existencefalse
has_role
optional
stringGroup Role Existencefalse
is_completed
optional
stringGroup Completion Statusfalse
creator_name
optional
stringCreator Last Name, First NameKim Samsung
creator_email
optional
stringCreator Emailsamsung.kim@samsung.com
modifier_name
optional
stringModifier Last Name, First NameKim Samsung
modifier_email
optional
stringModifier Emailsamsung.kim@samsung.com
exclude_user_id
optional
stringUser ID to Excludef39c460fade34fecb05ede8f904b24b7
exclude_policy_id
optional
stringPolicy ID to Exclude37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idIDf39c460fade34fecb05ede8f904b24b7
created_atCreated At2024-05-17T00:23:17Z
created_byCreatoref50cdc207f05f6fb8f20219f229ed1f
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
descriptionGroup DescriptionDescriptions for group
domain_nameDomain Namescp
membersGroup Member List
modified_atModified At2024-05-17T00:23:17Z
modified_byModifieref50cdc207f05f6fb8f20219f229ed1f
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
nameGroup NameTestGroup
policiesPolicy[]
resource_typeResource Namegroup
rolesRole Information[]
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda
typeGroup TypesUSER_DEFINED

3.1.36 - List IAM users

3.1.36.1 - 1.3

scpcli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]

Description

List IAM users

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
login_id
optional
stringLogin ID-
email
optional
stringUser Email-
nation_id
optional
stringNation ID-
phone_number
optional
stringUser Phone Number-
user_name
optional
stringUser Name-
exclude_group_id
optional
stringException Target Group-
exclude_policy_id
optional
stringException Target Policy-
type
optional
stringUser Type-

Responses

NameDescriptionExample
idID
account_idAccount ID
company_nameCompany Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionUser Description
dst_offsetDST Offset
emailUser Email
email_authenticatedEmail Authentication Status
first_nameUser Name
groupsGroup Names
last_login_atLast Login
last_nameUser Last Name
last_password_update_atLast Password Update Time
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName
password_reuse_countPassword Reuse Count
phone_authenticatedPhone Authentication Status
policiesUser Policies[]
stateStatus
timezoneTimezone ID
typeType
tz_idTimezone ID
user_nameUser Name
utc_offsetUTC Offset

3.1.36.2 - 1.2

scpcli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]

Description

List IAM users

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
login_id
optional
stringLogin ID-
email
optional
stringUser Email-
nation_id
optional
stringNation ID-
phone_number
optional
stringUser Phone Number-
user_name
optional
stringUser Name-
exclude_group_id
optional
stringException Target Group-
exclude_policy_id
optional
stringException Target Policy-
type
optional
stringUser Type-

Responses

NameDescriptionExample
idID
account_idAccount ID
company_nameCompany Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionUser Description
dst_offsetDST Offset
emailUser Email
email_authenticatedEmail Authentication Status
first_nameUser Name
groupsGroup Names
last_login_atLast Login
last_nameUser Last Name
last_password_update_atLast Password Update Time
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName
password_reuse_countPassword Reuse Count
phone_authenticatedPhone Authentication Status
policiesUser Policies[]
stateStatus
timezoneTimezone ID
typeType
tz_idTimezone ID
user_nameUser Name
utc_offsetUTC Offset

3.1.36.3 - 1.1

scpcli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]

Description

List IAM users

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
login_id
optional
stringLogin ID-
email
optional
stringUser Email-
nation_id
optional
stringNation ID-
phone_number
optional
stringUser Phone Number-
user_name
optional
stringUser Name-
exclude_group_id
optional
stringException Target Group-
exclude_policy_id
optional
stringException Target Policy-
type
optional
stringUser Type-

Responses

NameDescriptionExample
idID
account_idAccount ID
company_nameCompany Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionUser Description
dst_offsetDST Offset
emailUser Email
email_authenticatedEmail Authentication Status
first_nameUser Name
groupsGroup Names
last_login_atLast Login
last_nameUser Last Name
last_password_update_atLast Password Update Time
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName
password_reuse_countPassword Reuse Count
phone_authenticatedPhone Authentication Status
policiesUser Policies[]
stateStatus
timezoneTimezone ID
typeType
tz_idTimezone ID
user_nameUser Name
utc_offsetUTC Offset

3.1.36.4 - 1.0

scpcli iam iam user list
--account_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--login_id <value>]
[--email <value>]
[--nation_id <value>]
[--phone_number <value>]
[--user_name <value>]
[--exclude_group_id <value>]
[--exclude_policy_id <value>]
[--type <value>]

Description

List IAM users

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
account_id
required
stringAccount ID Field-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
login_id
optional
stringLogin ID-
email
optional
stringUser Email-
nation_id
optional
stringNation ID-
phone_number
optional
stringUser Phone Number-
user_name
optional
stringUser Name-
exclude_group_id
optional
stringException Target Group-
exclude_policy_id
optional
stringException Target Policy-
type
optional
stringUser Type-

Responses

NameDescriptionExample
idID
account_idAccount ID
company_nameCompany Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionUser Description
dst_offsetDST Offset
emailUser Email
email_authenticatedEmail Authentication Status
first_nameUser Name
groupsGroup Names
last_login_atLast Login
last_nameUser Last Name
last_password_update_atLast Password Update Time
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName
password_reuse_countPassword Reuse Count
phone_authenticatedPhone Authentication Status
policiesUser Policies[]
stateStatus
timezoneTimezone ID
typeType
tz_idTimezone ID
user_nameUser Name
utc_offsetUTC Offset

3.1.37 - List saml providers

3.1.37.1 - 1.3

scpcli iam saml provider list
[--size <value>]
[--page <value>]
[--sort <value>]
[--federation_type <value>]
[--saml_provider_name <value>]

Description

List saml providers

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
federation_type
optional
stringCredential Provider Type-
saml_provider_name
optional
stringCredential Provider Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.37.2 - 1.2

scpcli iam saml provider list
[--size <value>]
[--page <value>]
[--sort <value>]
[--federation_type <value>]
[--saml_provider_name <value>]

Description

List saml providers

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
federation_type
optional
stringCredential Provider Type-
saml_provider_name
optional
stringCredential Provider Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.37.3 - 1.1

scpcli iam saml provider list
[--size <value>]
[--page <value>]
[--sort <value>]
[--federation_type <value>]
[--saml_provider_name <value>]

Description

List saml providers

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
federation_type
optional
stringCredential Provider Type-
saml_provider_name
optional
stringCredential Provider Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.37.4 - 1.0

scpcli iam saml provider list
[--size <value>]
[--page <value>]
[--sort <value>]
[--federation_type <value>]
[--saml_provider_name <value>]

Description

List saml providers

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
federation_type
optional
stringCredential Provider Type-
saml_provider_name
optional
stringCredential Provider Name-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator
descriptionCredential Provider Description
federation_typeCredential Provider Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier
saml_provider_nameCredential Provider Name

3.1.38 - List service accounts

3.1.38.1 - 1.3

scpcli iam service account list
[--name <value>]
[--service <value>]

Description

List service accounts

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
name
optional
stringService Account Name-
service
optional
stringService Account's Service-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
serviceService Account’s Service

3.1.38.2 - 1.2

scpcli iam service account list
[--name <value>]
[--service <value>]

Description

List service accounts

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
name
optional
stringService Account Name-
service
optional
stringService Account's Service-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
serviceService Account’s Service

3.1.38.3 - 1.1

scpcli iam service account list
[--name <value>]
[--service <value>]

Description

List service accounts

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
name
optional
stringService Account Name-
service
optional
stringService Account's Service-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
serviceService Account’s Service

3.1.38.4 - 1.0

scpcli iam service account list
[--name <value>]
[--service <value>]

Description

List service accounts

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
name
optional
stringService Account Name-
service
optional
stringService Account's Service-

Responses

NameDescriptionExample
idService Account ID
nameService Account Name
serviceService Account’s Service

3.1.39 - Modify a Group

3.1.39.1 - 1.3

scpcli iam group set
--group_id <value>
--name <value>
--description <value>

Description

Modify a Group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
name
required
stringGroup NameTestGroup
description
required
stringGroup DescriptionDescriptions for group

3.1.39.2 - 1.2

scpcli iam group set
--group_id <value>
--name <value>
--description <value>

Description

Modify a Group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
name
required
stringGroup NameTestGroup
description
required
stringGroup DescriptionDescriptions for group

3.1.39.3 - 1.1

scpcli iam group set
--group_id <value>
--name <value>
--description <value>

Description

Modify a Group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
name
required
stringGroup NameTestGroup
description
required
stringGroup DescriptionDescriptions for group

3.1.39.4 - 1.0

scpcli iam group set
--group_id <value>
--name <value>
--description <value>

Description

Modify a Group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
name
required
stringGroup NameTestGroup
description
required
stringGroup DescriptionDescriptions for group

3.1.40 - Query policy list

3.1.40.1 - 1.3

scpcli iam policy query
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
[--excluded_policy_ids <value>]

Description

Query policy list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringCreator Last Name, First Nametest1
creator_email
optional
stringCreator Emailtest@test.com
modifier_name
optional
stringModifier Last Name, First Nametest1
modifier_email
optional
stringModifier Emailtest@test.com
exclude_group_id
optional
stringGroup ID to Excludea946662dc4314dac93da413a32457459
exclude_user_id
optional
stringUser ID to Exclude-
excluded_policy_ids
optional
arrayPolicy IDs to Exclude37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.40.2 - 1.2

scpcli iam policy query
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
[--excluded_policy_ids <value>]

Description

Query policy list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringCreator Last Name, First Nametest1
creator_email
optional
stringCreator Emailtest@test.com
modifier_name
optional
stringModifier Last Name, First Nametest1
modifier_email
optional
stringModifier Emailtest@test.com
exclude_group_id
optional
stringGroup ID to Excludea946662dc4314dac93da413a32457459
exclude_user_id
optional
stringUser ID to Exclude-
excluded_policy_ids
optional
arrayPolicy IDs to Exclude37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.40.3 - 1.1

scpcli iam policy query
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
[--excluded_policy_ids <value>]

Description

Query policy list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringCreator Last Name, First Nametest1
creator_email
optional
stringCreator Emailtest@test.com
modifier_name
optional
stringModifier Last Name, First Nametest1
modifier_email
optional
stringModifier Emailtest@test.com
exclude_group_id
optional
stringGroup ID to Excludea946662dc4314dac93da413a32457459
exclude_user_id
optional
stringUser ID to Exclude-
excluded_policy_ids
optional
arrayPolicy IDs to Exclude37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.40.4 - 1.0

scpcli iam policy query
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--policy_name <value>]
[--policy_type <value>]
[--service_type <value>]
[--creator_name <value>]
[--creator_email <value>]
[--modifier_name <value>]
[--modifier_email <value>]
[--exclude_group_id <value>]
[--exclude_user_id <value>]
[--excluded_policy_ids <value>]

Description

Query policy list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy TypeSYSTEM_MANAGED
service_type
optional
stringService Typescp-iam
creator_name
optional
stringCreator Last Name, First Nametest1
creator_email
optional
stringCreator Emailtest@test.com
modifier_name
optional
stringModifier Last Name, First Nametest1
modifier_email
optional
stringModifier Emailtest@test.com
exclude_group_id
optional
stringGroup ID to Excludea946662dc4314dac93da413a32457459
exclude_user_id
optional
stringUser ID to Exclude-
excluded_policy_ids
optional
arrayPolicy IDs to Exclude37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.41 - Remove a permission into the resource based policy

3.1.41.1 - 1.3

scpcli iam permission remove
--sid <value>
--srn <value>

Description

Remove a permission into the resource based policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

3.1.41.2 - 1.2

scpcli iam permission remove
--sid <value>
--srn <value>

Description

Remove a permission into the resource based policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

3.1.41.3 - 1.1

scpcli iam permission remove
--sid <value>
--srn <value>

Description

Remove a permission into the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

3.1.41.4 - 1.0

scpcli iam permission remove
--sid <value>
--srn <value>

Description

Remove a permission into the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

3.1.42 - Remove a User from a Group

3.1.42.1 - 1.3

scpcli iam group user remove
--user_id <value>
--group_id <value>

Description

Remove a User from a Group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser IDef50cdc207f05f6fb8f20219f229ed1f
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.42.2 - 1.2

scpcli iam group user remove
--user_id <value>
--group_id <value>

Description

Remove a User from a Group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_id
required
stringUser IDef50cdc207f05f6fb8f20219f229ed1f
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.42.3 - 1.1

scpcli iam group user remove
--user_id <value>
--group_id <value>

Description

Remove a User from a Group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser IDef50cdc207f05f6fb8f20219f229ed1f
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.42.4 - 1.0

scpcli iam group user remove
--user_id <value>
--group_id <value>

Description

Remove a User from a Group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser IDef50cdc207f05f6fb8f20219f229ed1f
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.43 - Remove policies

3.1.43.1 - 1.3

scpcli iam policy bulk delete
[--ids <value>]

Description

Remove policies

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
ids
optional
arrayID List37f2e31ff86b415698d7e8eeafab445d

3.1.43.2 - 1.2

scpcli iam policy bulk delete
[--ids <value>]

Description

Remove policies

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
ids
optional
arrayID List37f2e31ff86b415698d7e8eeafab445d

3.1.43.3 - 1.1

scpcli iam policy bulk delete
[--ids <value>]

Description

Remove policies

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
ids
optional
arrayID List37f2e31ff86b415698d7e8eeafab445d

3.1.43.4 - 1.0

scpcli iam policy bulk delete
[--ids <value>]

Description

Remove policies

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
ids
optional
arrayID List37f2e31ff86b415698d7e8eeafab445d

3.1.44 - Remove policy assignment from group

3.1.44.1 - 1.3

scpcli iam group policy delete
--policy_id <value>
--group_id <value>

Description

Remove policy assignment from group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.44.2 - 1.2

scpcli iam group policy delete
--policy_id <value>
--group_id <value>

Description

Remove policy assignment from group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.44.3 - 1.1

scpcli iam group policy delete
--policy_id <value>
--group_id <value>

Description

Remove policy assignment from group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.44.4 - 1.0

scpcli iam group policy delete
--policy_id <value>
--group_id <value>

Description

Remove policy assignment from group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.45 - Remove saml providers

3.1.45.1 - 1.3

scpcli iam saml provider bulk delete
[--ids <value>]

Description

Remove saml providers

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
ids
optional
arrayCredential Provider ID List-

3.1.45.2 - 1.2

scpcli iam saml provider bulk delete
[--ids <value>]

Description

Remove saml providers

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
ids
optional
arrayCredential Provider ID List-

3.1.45.3 - 1.1

scpcli iam saml provider bulk delete
[--ids <value>]

Description

Remove saml providers

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
ids
optional
arrayCredential Provider ID List-

3.1.45.4 - 1.0

scpcli iam saml provider bulk delete
[--ids <value>]

Description

Remove saml providers

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
ids
optional
arrayCredential Provider ID List-

3.1.46 - Remove the access key

3.1.46.1 - 1.3

scpcli iam access-key delete
--access_key_id <value>

Description

Remove the access key

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7

3.1.46.2 - 1.2

scpcli iam access-key delete
--access_key_id <value>

Description

Remove the access key

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7

3.1.46.3 - 1.1

scpcli iam access-key delete
--access_key_id <value>

Description

Remove the access key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7

3.1.46.4 - 1.0

scpcli iam access-key delete
--access_key_id <value>

Description

Remove the access key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7

3.1.47 - Remove the access keys

3.1.47.1 - 1.3

scpcli iam access-key remove
[--ids <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--with_count <value>]

Description

Remove the access keys

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
ids
optional
arrayAccess Key ID List-
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
with_count
optional
stringwith counttrue

3.1.47.2 - 1.2

scpcli iam access-key remove
[--ids <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--with_count <value>]

Description

Remove the access keys

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
ids
optional
arrayAccess Key ID List-
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
with_count
optional
stringwith counttrue

3.1.47.3 - 1.1

scpcli iam access-key remove
[--ids <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--with_count <value>]

Description

Remove the access keys

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
ids
optional
arrayAccess Key ID List-
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
with_count
optional
stringwith counttrue

3.1.47.4 - 1.0

scpcli iam access-key remove
[--ids <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--with_count <value>]

Description

Remove the access keys

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
ids
optional
arrayAccess Key ID List-
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
with_count
optional
stringwith counttrue

3.1.48 - Remove the Group

3.1.48.1 - 1.3

scpcli iam group delete
--group_id <value>

Description

Remove the Group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.48.2 - 1.2

scpcli iam group delete
--group_id <value>

Description

Remove the Group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.48.3 - 1.1

scpcli iam group delete
--group_id <value>

Description

Remove the Group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.48.4 - 1.0

scpcli iam group delete
--group_id <value>

Description

Remove the Group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459

3.1.49 - Send Temporary Access Key OTP

3.1.49.1 - 1.3

scpcli iam access-key send otp
[--locale <value>]
[--method <value>]

Description

Send Temporary Access Key OTP

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
locale
optional
stringLocale-
method
optional
stringOTP Method (EMAIL or PHONE)-

Responses

NameDescriptionExample

3.1.49.2 - 1.2

scpcli iam access-key send otp
[--locale <value>]
[--method <value>]

Description

Send Temporary Access Key OTP

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
locale
optional
stringLocale-
method
optional
stringOTP Method (EMAIL or PHONE)-

Responses

NameDescriptionExample

3.1.49.3 - 1.1

scpcli iam access-key send otp
[--locale <value>]
[--method <value>]

Description

Send Temporary Access Key OTP

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
locale
optional
stringLocale-
method
optional
stringOTP Method (EMAIL or PHONE)-

Responses

NameDescriptionExample

3.1.49.4 - 1.0

scpcli iam access-key send otp
[--locale <value>]
[--method <value>]

Description

Send Temporary Access Key OTP

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
locale
optional
stringLocale-
method
optional
stringOTP Method (EMAIL or PHONE)-

Responses

NameDescriptionExample

3.1.50 - Set a permission into the resource based policy

3.1.50.1 - 1.3

scpcli iam permission set
--sid <value>
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Set a permission into the resource based policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

3.1.50.2 - 1.2

scpcli iam permission set
--sid <value>
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Set a permission into the resource based policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

3.1.50.3 - 1.1

scpcli iam permission set
--sid <value>
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Set a permission into the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

3.1.50.4 - 1.0

scpcli iam permission set
--sid <value>
--srn <value>
--effect <value>
[--action <value>]
[--condition <value>]
[--notaction <value>]
[--principal <value>]
[--resource <value>]
[--sid <value>]

Description

Set a permission into the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
sid
required
stringStatement IDStatement1
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
effect
required
stringEffectAllow
action
optional
arrayActionvirtualserver:ShowVirtualServer
condition
optional
objectCondition{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}
notaction
optional
arrayNotAction-
principal
optional
stringPrincipal*
resource
optional
arrayResourcesrn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666
sid
optional
stringStatement IdStatement1

3.1.51 - Set an access key

3.1.51.1 - 1.3

scpcli iam access-key set
--access_key_id <value>
[--is_enabled <value>]

Description

Set or update an access key

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7
is_enabled
optional
booleanActivation Statustrue

3.1.51.2 - 1.2

scpcli iam access-key set
--access_key_id <value>
[--is_enabled <value>]

Description

Set or update an access key

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7
is_enabled
optional
booleanActivation Statustrue

3.1.51.3 - 1.1

scpcli iam access-key set
--access_key_id <value>
[--is_enabled <value>]

Description

Set or update an access key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7
is_enabled
optional
booleanActivation Statustrue

3.1.51.4 - 1.0

scpcli iam access-key set
--access_key_id <value>
[--is_enabled <value>]

Description

Set or update an access key

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
access_key_id
required
stringAccess Key IDf39c460fade34fecb05ede8f904b24b7
is_enabled
optional
booleanActivation Statustrue

3.1.52 - Set role

3.1.52.1 - 1.3

scpcli iam role set
--role_id <value>
[--description <value>]
[--max_session_duration <value>]

Description

Set role

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
description
optional
stringRole Description-
max_session_duration
optional
integerRole Maximum Session Duration (seconds)3600

3.1.52.2 - 1.2

scpcli iam role set
--role_id <value>
[--description <value>]
[--max_session_duration <value>]

Description

Set role

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
description
optional
stringRole Description-
max_session_duration
optional
integerRole Maximum Session Duration (seconds)3600

3.1.52.3 - 1.1

scpcli iam role set
--role_id <value>
[--description <value>]
[--max_session_duration <value>]

Description

Set role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
description
optional
stringRole Description-
max_session_duration
optional
integerRole Maximum Session Duration (seconds)3600

3.1.52.4 - 1.0

scpcli iam role set
--role_id <value>
[--description <value>]
[--max_session_duration <value>]

Description

Set role

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
description
optional
stringRole Description-
max_session_duration
optional
integerRole Maximum Session Duration (seconds)3600

3.1.53 - Set role trust policy

3.1.53.1 - 1.3

scpcli iam role trust policy
--role_id <value>
--version <value>
--statement <value>

Description

Set role trust policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'

3.1.53.2 - 1.2

scpcli iam role trust policy
--role_id <value>
--version <value>
--statement <value>

Description

Set role trust policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'

3.1.53.3 - 1.1

scpcli iam role trust policy
--role_id <value>
--version <value>
--statement <value>

Description

Set role trust policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'

3.1.53.4 - 1.0

scpcli iam role trust policy
--role_id <value>
--version <value>
--statement <value>

Description

Set role trust policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
role_id
required
stringRole ID-
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'

3.1.54 - Set the policy

3.1.54.1 - 1.3

scpcli iam policy set
--policy_id <value>
--version <value>
--statement <value>
[--default_version_id <value>]
[--description <value>]
[--policy_name <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
default_version_id
optional
stringDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_name
optional
stringPolicy NamePolicy1
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

3.1.54.2 - 1.2

scpcli iam policy set
--policy_id <value>
--version <value>
--statement <value>
[--default_version_id <value>]
[--description <value>]
[--policy_name <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
default_version_id
optional
stringDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_name
optional
stringPolicy NamePolicy1
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

3.1.54.3 - 1.1

scpcli iam policy set
--policy_id <value>
--version <value>
--statement <value>
[--default_version_id <value>]
[--description <value>]
[--policy_name <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
default_version_id
optional
stringDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_name
optional
stringPolicy NamePolicy1
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

3.1.54.4 - 1.0

scpcli iam policy set
--policy_id <value>
--version <value>
--statement <value>
[--default_version_id <value>]
[--description <value>]
[--policy_name <value>]
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
default_version_id
optional
stringDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
description
optional
stringDescriptionDescriptions for policy
policy_name
optional
stringPolicy NamePolicy1
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

3.1.55 - Set the resource based policy

3.1.55.1 - 1.3

scpcli iam resource policy set
--srn <value>
--version <value>
--statement <value>
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the resource based policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

3.1.55.2 - 1.2

scpcli iam resource policy set
--srn <value>
--version <value>
--statement <value>
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the resource based policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

3.1.55.3 - 1.1

scpcli iam resource policy set
--srn <value>
--version <value>
--statement <value>
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

3.1.55.4 - 1.0

scpcli iam resource policy set
--srn <value>
--version <value>
--statement <value>
[--policy_id <value>]
[--policy_version_id <value>]
[--policy_version_name <value>]

Description

Set the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=
version
required
stringPolicy Version2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_id
optional
stringPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
policy_version_name
optional
stringPolicy Version NamePolicyVersion-1

3.1.56 - Show group policy

3.1.56.1 - 1.3

scpcli iam group policy show
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Show group policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.56.2 - 1.2

scpcli iam group policy show
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Show group policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.56.3 - 1.1

scpcli iam group policy show
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Show group policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.56.4 - 1.0

scpcli iam group policy show
--group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_id <value>]
[--policy_name <value>]
[--policy_type <value>]

Description

Show group policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup IDa946662dc4314dac93da413a32457459
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_id
optional
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_name
optional
stringPolicy NameViewerAccess
policy_type
optional
stringPolicy Type['SYSTEM_MANAGED', 'USER_DEFINED']

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
account_idAccount Ide99c73a8690d4ae39ae75e38a26f2b99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_emailCreator Emailsamsung.kim@samsung.com
creator_nameCreator Last Name, First NameKim Samsung
default_version_idDefault Version Idc1b1fc611eb34eccbccfb563f77395ee
descriptionDescriptionDescriptions for policy
domain_nameDomain Namescp
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_emailModifier Emailsamsung.kim@samsung.com
modifier_nameModifier Last Name, First NameKim Samsung
policy_categoryPolicy CategoryIDENTITY_BASED
policy_namePolicy NamePolicyName
policy_typePolicy TypeUSER_DEFINED
policy_versionsPolicy Versions
resource_typeResource Typepolicy
service_nameService NameIdentity Access Management
service_typeService Typeiam
srnSamsung Resource Namesrn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d
statePolicy StateACTIVE

3.1.57 - Show the policy

3.1.57.1 - 1.3

scpcli iam policy show
--policy_id <value>

Description

Show the policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

3.1.57.2 - 1.2

scpcli iam policy show
--policy_id <value>

Description

Show the policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

3.1.57.3 - 1.1

scpcli iam policy show
--policy_id <value>

Description

Show the policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

3.1.57.4 - 1.0

scpcli iam policy show
--policy_id <value>

Description

Show the policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
policy_id
required
stringPolicy ID37f2e31ff86b415698d7e8eeafab445d

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document
policy_idPolicy ID37f2e31ff86b415698d7e8eeafab445d
policy_version_namePolicy Version NamePolicyVersion-1

3.1.58 - Show the resource based policy

3.1.58.1 - 1.3

scpcli iam resource policy show
--srn <value>

Description

Show the resource based policy

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document{‘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’}

3.1.58.2 - 1.2

scpcli iam resource policy show
--srn <value>

Description

Show the resource based policy

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document{‘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’}

3.1.58.3 - 1.1

scpcli iam resource policy show
--srn <value>

Description

Show the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document{‘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’}

3.1.58.4 - 1.0

scpcli iam resource policy show
--srn <value>

Description

Show the resource based policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
srn
required
stringSamsung Resource Namec3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY=

Responses

NameDescriptionExample
idPolicy Version Idc1b1fc611eb34eccbccfb563f77395ee
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
policy_documentPolicy Document{‘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’}

3.1.59 - Update IAM user

3.1.59.1 - 1.3

scpcli iam iam user set
--user_id <value>
--account_id <value>
--password_reuse_count <value>
[--description <value>]

Description

Update IAM user

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-
password_reuse_count
required
integerPassword Reuse Count-
description
optional
stringUser Description-

3.1.59.2 - 1.2

scpcli iam iam user set
--user_id <value>
--account_id <value>
--password_reuse_count <value>
[--description <value>]

Description

Update IAM user

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-
password_reuse_count
required
integerPassword Reuse Count-
description
optional
stringUser Description-

3.1.59.3 - 1.1

scpcli iam iam user set
--user_id <value>
--account_id <value>
--password_reuse_count <value>
[--description <value>]

Description

Update IAM user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-
password_reuse_count
required
integerPassword Reuse Count-
description
optional
stringUser Description-

3.1.59.4 - 1.0

scpcli iam iam user set
--user_id <value>
--account_id <value>
--password_reuse_count <value>
[--description <value>]

Description

Update IAM user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-
password_reuse_count
required
integerPassword Reuse Count-
description
optional
stringUser Description-

3.1.60 - Update IAM user password

3.1.60.1 - 1.3

scpcli iam iam user password set
--user_id <value>
--account_id <value>
--password <value>
[--temporary_password <value>]

Description

Update IAM user password

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-
password
required
stringPassword-
temporary_password
optional
booleanTemporary-

3.1.60.2 - 1.2

scpcli iam iam user password set
--user_id <value>
--account_id <value>
--password <value>
[--temporary_password <value>]

Description

Update IAM user password

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-
password
required
stringPassword-
temporary_password
optional
booleanTemporary-

3.1.60.3 - 1.1

scpcli iam iam user password set
--user_id <value>
--account_id <value>
--password <value>
[--temporary_password <value>]

Description

Update IAM user password

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-
password
required
stringPassword-
temporary_password
optional
booleanTemporary-

3.1.60.4 - 1.0

scpcli iam iam user password set
--user_id <value>
--account_id <value>
--password <value>
[--temporary_password <value>]

Description

Update IAM user password

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser ID-
account_id
required
stringAccount ID Field-
password
required
stringPassword-
temporary_password
optional
booleanTemporary-

3.1.61 - Update saml provider information

3.1.61.1 - 1.3

scpcli iam saml provider set
--saml_provider_id <value>
[--description <value>]
[--file <value>]
[--saml_provider_name <value>]
[--tags <value>]

Description

Update saml provider information

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
saml_provider_id
required
stringCredential Provider ID-
description
optional
stringCredential Provider DescriptionSAML provider Description
file
optional
stringMetadata Filekeycloak-idp-saml.xml
saml_provider_name
optional
stringCredential Provider NameIdpTest
tags
optional
arrayTags{'key': 'company', 'value': 'SDS'}

3.1.61.2 - 1.2

scpcli iam saml provider set
--saml_provider_id <value>
[--description <value>]
[--file <value>]
[--saml_provider_name <value>]
[--tags <value>]

Description

Update saml provider information

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
saml_provider_id
required
stringCredential Provider ID-
description
optional
stringCredential Provider DescriptionSAML provider Description
file
optional
stringMetadata Filekeycloak-idp-saml.xml
saml_provider_name
optional
stringCredential Provider NameIdpTest
tags
optional
arrayTags{'key': 'company', 'value': 'SDS'}

3.1.61.3 - 1.1

scpcli iam saml provider set
--saml_provider_id <value>
[--description <value>]
[--file <value>]
[--saml_provider_name <value>]
[--tags <value>]

Description

Update saml provider information

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
saml_provider_id
required
stringCredential Provider ID-
description
optional
stringCredential Provider DescriptionSAML provider Description
file
optional
stringMetadata Filekeycloak-idp-saml.xml
saml_provider_name
optional
stringCredential Provider NameIdpTest
tags
optional
arrayTags{'key': 'company', 'value': 'SDS'}

3.1.61.4 - 1.0

scpcli iam saml provider set
--saml_provider_id <value>
[--description <value>]
[--file <value>]
[--saml_provider_name <value>]
[--tags <value>]

Description

Update saml provider information

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
saml_provider_id
required
stringCredential Provider ID-
description
optional
stringCredential Provider DescriptionSAML provider Description
file
optional
stringMetadata Filekeycloak-idp-saml.xml
saml_provider_name
optional
stringCredential Provider NameIdpTest
tags
optional
arrayTags{'key': 'company', 'value': 'SDS'}

4 - ID Center

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of IAM service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.3CURRENT-
1.2SUPPORTED20260930
1.1DEPRECATED20260531
1.0DEPRECATED20260223

4.1 - CLIs

4.1.1 - CreateAccountAssignment

4.1.1.1 - 1.3

scpcli iam-identity-center create account assignments
--instance_id <value>
[--accounts <value>]
[--permission_sets <value>]
[--principals <value>]

Description

set a specific account Assignment

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
accounts
optional
array'{"target_account_email": "target_account@example.com", "target_account_id": "3265ab469f0d406d83073da3e11e7a6c", "target_account_name": "target_account@example.com"}'
permission_sets
optional
array'{"custom_policies": [], "inline_policies": [], "managed_policies": [], "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1", "permission_set_name": "Permission Set", "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}", "session_duration": 3600}'
principals
optional
array'{"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2", "principal_type": "USER"}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
permission_set_idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_typePrincipal TypeUSER
target_account_idAssigned Account ID3265ab469f0d406d83073da3e11e7a6c

4.1.1.2 - 1.2

scpcli iam-identity-center create account assignments
--instance_id <value>
[--accounts <value>]
[--permission_sets <value>]
[--principals <value>]

Description

set a specific account Assignment

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
accounts
optional
array'{"target_account_email": "target_account@example.com", "target_account_id": "3265ab469f0d406d83073da3e11e7a6c", "target_account_name": "target_account@example.com"}'
permission_sets
optional
array'{"custom_policies": [], "inline_policies": [], "managed_policies": [], "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1", "permission_set_name": "Permission Set", "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}", "session_duration": 3600}'
principals
optional
array'{"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2", "principal_type": "USER"}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
permission_set_idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_typePrincipal TypeUSER
target_account_idAssigned Account ID3265ab469f0d406d83073da3e11e7a6c

4.1.1.3 - 1.1

scpcli iam-identity-center create account assignments
--instance_id <value>
[--accounts <value>]
[--permission_sets <value>]
[--principals <value>]

Description

set a specific account Assignment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
accounts
optional
array'{"target_account_email": "target_account@example.com", "target_account_id": "3265ab469f0d406d83073da3e11e7a6c", "target_account_name": "target_account@example.com"}'
permission_sets
optional
array'{"customer_policies": [], "inline_policies": [], "managed_policies": [], "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1", "permission_set_name": "Permission Set", "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}", "session_duration": 3600}'
principals
optional
array'{"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2", "principal_type": "USER"}'

Responses

NameDescriptionExample
account_assignment_idAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
permission_set_idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_typePrincipal TypeUSER
role_srnPermission Set DescriptionPermissions for administrators
target_account_idAssigned Account ID3265ab469f0d406d83073da3e11e7a6c

4.1.1.4 - 1.0

scpcli iam-identity-center create account assignments
--instance_id <value>
[--accounts <value>]
[--permission_sets <value>]
[--principals <value>]

Description

set a specific account Assignment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
accounts
optional
array'{"target_account_email": "target_account@example.com", "target_account_id": "3265ab469f0d406d83073da3e11e7a6c", "target_account_name": "target_account@example.com"}'
permission_sets
optional
array'{"customer_policies": [], "inline_policies": [], "managed_policies": [], "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1", "permission_set_name": "Permission Set", "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}", "session_duration": 3600}'
principals
optional
array'{"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2", "principal_type": "USER"}'

Responses

NameDescriptionExample
account_assignment_idAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
permission_set_idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_typePrincipal TypeUSER
role_srnPermission Set DescriptionPermissions for administrators
target_account_idAssigned Account ID3265ab469f0d406d83073da3e11e7a6c

4.1.2 - CreateBulkGroupUsers

4.1.2.1 - 1.3

scpcli iam-identity-center group bulk user add
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

add multiple users to a specific group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.2.2 - 1.2

scpcli iam-identity-center group bulk user add
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

add multiple users to a specific group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.2.3 - 1.1

scpcli iam-identity-center group bulk user add
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

add multiple users to a specific group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.2.4 - 1.0

scpcli iam-identity-center group bulk user add
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

add multiple users to a specific group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.3 - CreateGroup

4.1.3.1 - 1.3

scpcli iam-identity-center group create
--name <value>
--instance_id <value>
[--description <value>]
[--user_uuids <value>]

Description

create a group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringGroup NameAdmin_Group
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
user_uuids
optional
arrayList of User IDs to be added to the group138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.3.2 - 1.2

scpcli iam-identity-center group create
--name <value>
--instance_id <value>
[--description <value>]
[--user_uuids <value>]

Description

create a group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
name
required
stringGroup NameAdmin_Group
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
user_uuids
optional
arrayList of User IDs to be added to the group138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.3.3 - 1.1

scpcli iam-identity-center group create
--name <value>
--instance_id <value>
[--description <value>]
[--user_uuids <value>]

Description

create a group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
name
required
stringGroup NameAdmin_Group
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
user_uuids
optional
arrayList of User IDs to be added to the group138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.3.4 - 1.0

scpcli iam-identity-center group create
--name <value>
--instance_id <value>
[--description <value>]
[--user_uuids <value>]

Description

create a group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
name
required
stringGroup NameAdmin_Group
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
user_uuids
optional
arrayList of User IDs to be added to the group138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.4 - CreateInstance

4.1.4.1 - 1.3

scpcli iam-identity-center instance create
--name <value>
[--description <value>]
[--identity_store_type <value>]
[--bind_credential <value>]
[--bind_dn <value>]
[--connection_url <value>]
[--rdn_ldap_attribute <value>]
[--user_object_classes <value>]
[--username_ldap_attribute <value>]
[--users_dn <value>]

Description

create a instance

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringInstance NameMy Instance
description
optional
stringInstance DescriptionMy Instance Description
identity_store_type
optional
stringIdentity Store Type-
bind_credential
optional
stringBind Passwordpassword
bind_dn
optional
stringBind DNCN=Administrator,CN=Users,DC=test,DC=add
connection_url
optional
stringLDAP Server URLldaps://test.subdomain.company.com:123
rdn_ldap_attribute
optional
stringRDN LDAP Attributecn
user_object_classes
optional
stringUser Object Classesperson, organizationalPerson, user
username_ldap_attribute
optional
stringUsername LDAP AttributesAMAccountName
users_dn
optional
stringUsers DNOU=Employees,OU=Accounts,DC=sub,DC=org

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delegated_account_idDelegated Account IDacc-2353
delegated_atDelegation Date2023-10-15 14:30:00
delegated_byDelegated Bysef2w3c8c29a449dbfa8681f8f1d78e2
descriptionInstance DescriptionMy Instance Description
identity_store_configIdentity Store Config{‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’}
identity_store_idIdentity Store IDd-12345
identity_store_typeIdentity Store Type
last_sync_atLast Sync Date2025-08-06 10:30:00
last_sync_statusLast Sync Status[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’]
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInstance NameMy Instance
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO Start URLhttps://login.e.samsungsdscloud.com/d-12345
stateState

4.1.4.2 - 1.2

scpcli iam-identity-center instance create
--name <value>
[--description <value>]
[--identity_store_type <value>]
[--bind_credential <value>]
[--bind_dn <value>]
[--connection_url <value>]
[--rdn_ldap_attribute <value>]
[--user_object_classes <value>]
[--username_ldap_attribute <value>]
[--users_dn <value>]

Description

create a instance

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
name
required
stringInstance NameMy Instance
description
optional
stringInstance DescriptionMy Instance Description
identity_store_type
optional
stringIdentity Store Type-
bind_credential
optional
stringBind Passwordpassword
bind_dn
optional
stringBind DNCN=Administrator,CN=Users,DC=test,DC=add
connection_url
optional
stringLDAP Server URLldaps://test.subdomain.company.com:123
rdn_ldap_attribute
optional
stringRDN LDAP Attributecn
user_object_classes
optional
stringUser Object Classesperson, organizationalPerson, user
username_ldap_attribute
optional
stringUsername LDAP AttributesAMAccountName
users_dn
optional
stringUsers DNOU=Employees,OU=Accounts,DC=sub,DC=org

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delegated_account_idDelegated Account IDacc-2353
delegated_atDelegation Date2023-10-15 14:30:00
delegated_byDelegated Bysef2w3c8c29a449dbfa8681f8f1d78e2
descriptionInstance DescriptionMy Instance Description
identity_store_configIdentity Store Config{‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’}
identity_store_idIdentity Store IDd-12345
identity_store_typeIdentity Store Type
last_sync_atLast Sync Date2025-08-06 10:30:00
last_sync_statusLast Sync Status[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’]
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInstance NameMy Instance
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO Start URLhttps://login.e.samsungsdscloud.com/d-12345
stateState

4.1.4.3 - 1.1

scpcli iam-identity-center instance create
--name <value>
[--description <value>]
[--identity_store_type <value>]
[--bind_credential <value>]
[--bind_dn <value>]
[--connection_url <value>]
[--rdn_ldap_attribute <value>]
[--user_object_classes <value>]
[--username_ldap_attribute <value>]
[--users_dn <value>]

Description

create a instance

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
name
required
stringInstance NameMy Instance
description
optional
stringInstance DescriptionMy Instance Description
identity_store_type
optional
stringIdentity Store Type-
bind_credential
optional
stringBind Passwordpassword
bind_dn
optional
stringBind DNCN=Administrator,CN=Users,DC=test,DC=add
connection_url
optional
stringLDAP Server URLldaps://test.subdomain.company.com:123
rdn_ldap_attribute
optional
stringRDN LDAP Attributecn
user_object_classes
optional
stringUser Object Classesperson, organizationalPerson, user
username_ldap_attribute
optional
stringUsername LDAP AttributesAMAccountName
users_dn
optional
stringUsers DNOU=Employees,OU=Accounts,DC=sub,DC=org

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delegated_account_idDelegated Account IDacc-2353
delegated_atDelegation Date2023-10-15 14:30:00
delegated_byDelegated Bysef2w3c8c29a449dbfa8681f8f1d78e2
descriptionInstance DescriptionMy Instance Description
identity_store_configIdentity Store Config{‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’}
identity_store_idIdentity Store IDd-12345
identity_store_typeIdentity Store Type
last_sync_atLast Sync Date2025-08-06 10:30:00
last_sync_statusLast Sync Status[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’]
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInstance NameMy Instance
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO Start URLhttps://login.e.samsungsdscloud.com/d-12345
stateState

4.1.5 - CreatePermissionSet

4.1.5.1 - 1.3

scpcli iam-identity-center permission set create
--session_duration <value>
--name <value>
--instance_id <value>
[--custom_policies <value>]
[--description <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

create a permission set

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
session_duration
required
integerMaximum Session Duration3600
name
required
stringInstance NameMy Instance
instance_id
required
stringInstance IDssoins-12345
custom_policies
optional
arrayCustomer Managed Policy-
description
optional
stringInstance DescriptionMy Instance Description
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy'{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}'

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.5.2 - 1.2

scpcli iam-identity-center permission set create
--session_duration <value>
--name <value>
--instance_id <value>
[--custom_policies <value>]
[--description <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

create a permission set

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
session_duration
required
integerMaximum Session Duration3600
name
required
stringInstance NameMy Instance
instance_id
required
stringInstance IDssoins-12345
custom_policies
optional
arrayCustomer Managed Policy-
description
optional
stringInstance DescriptionMy Instance Description
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy'{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}'

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.5.3 - 1.1

scpcli iam-identity-center permission set create
--session_duration <value>
--name <value>
--instance_id <value>
[--customer_policies <value>]
[--description <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

create a permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
session_duration
required
integerMaximum Session Duration3600
name
required
stringInstance NameMy Instance
instance_id
required
stringInstance IDssoins-12345
customer_policies
optional
arrayCustomer Managed Policy-
description
optional
stringInstance DescriptionMy Instance Description
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy'{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}'

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.5.4 - 1.0

scpcli iam-identity-center permission set create
--session_duration <value>
--name <value>
--instance_id <value>
[--customer_policies <value>]
[--description <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

create a permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
session_duration
required
integerMaximum Session Duration3600
name
required
stringInstance NameMy Instance
instance_id
required
stringInstance IDssoins-12345
customer_policies
optional
arrayCustomer Managed Policy-
description
optional
stringInstance DescriptionMy Instance Description
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy'{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}'

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.6 - CreateUser

4.1.6.1 - 1.3

scpcli iam-identity-center user create
--user_id <value>
--name <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--group_ids <value>]
[--manager <value>]
[--nation_id <value>]
[--password <value>]
[--phone_number <value>]
[--temporary_password <value>]

Description

create a user

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_id
required
stringUser Login IDjohndoe
name
required
stringReal NameJohn Doe
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
group_ids
optional
arrayList of Groups the User Belongs To39520424-440c-41c0-9b9c-f22b2129f6f9
manager
optional
stringManagerAlice Smith
nation_id
optional
stringNationality ID+82
password
optional
stringPassword-
phone_number
optional
stringPhone Number010-1234-5678
temporary_password
optional
booleanTemporary Password Status-

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

4.1.6.2 - 1.2

scpcli iam-identity-center user create
--user_id <value>
--name <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--group_ids <value>]
[--manager <value>]
[--nation_id <value>]
[--password <value>]
[--phone_number <value>]
[--temporary_password <value>]

Description

create a user

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_id
required
stringUser Login IDjohndoe
name
required
stringReal NameJohn Doe
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
group_ids
optional
arrayList of Groups the User Belongs To39520424-440c-41c0-9b9c-f22b2129f6f9
manager
optional
stringManagerAlice Smith
nation_id
optional
stringNationality ID+82
password
optional
stringPassword-
phone_number
optional
stringPhone Number010-1234-5678
temporary_password
optional
booleanTemporary Password Status-

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

4.1.6.3 - 1.1

scpcli iam-identity-center user create
--user_id <value>
--name <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--group_ids <value>]
[--manager <value>]
[--nation_id <value>]
[--password <value>]
[--phone_number <value>]
[--temporary_password <value>]

Description

create a user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_id
required
stringUser Login IDjohndoe
name
required
stringReal NameJohn Doe
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
group_ids
optional
arrayList of Groups the User Belongs To39520424-440c-41c0-9b9c-f22b2129f6f9
manager
optional
stringManagerAlice Smith
nation_id
optional
stringNationality ID+82
password
optional
stringPassword-
phone_number
optional
stringPhone Number010-1234-5678
temporary_password
optional
booleanTemporary Password Status-

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

4.1.6.4 - 1.0

scpcli iam-identity-center user create
--user_id <value>
--name <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--group_ids <value>]
[--manager <value>]
[--nation_id <value>]
[--password <value>]
[--phone_number <value>]
[--temporary_password <value>]

Description

create a user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
user_id
required
stringUser Login IDjohndoe
name
required
stringReal NameJohn Doe
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
group_ids
optional
arrayList of Groups the User Belongs To39520424-440c-41c0-9b9c-f22b2129f6f9
manager
optional
stringManagerAlice Smith
nation_id
optional
stringNationality ID+82
password
optional
stringPassword-
phone_number
optional
stringPhone Number010-1234-5678
temporary_password
optional
booleanTemporary Password Status-

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

4.1.7 - DeleteAccountAssignment

4.1.7.1 - 1.3

scpcli iam-identity-center account delete
--account_assignment_id <value>
--target_account_id <value>
--instance_id <value>
[--only_user_removed <value>]

Description

delete a specific account Assignment

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
account_assignment_id
required
stringAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
only_user_removed
optional
booleanExclude Directly Applied Only-

4.1.7.2 - 1.2

scpcli iam-identity-center account delete
--account_assignment_id <value>
--target_account_id <value>
--instance_id <value>
[--only_user_removed <value>]

Description

delete a specific account Assignment

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
account_assignment_id
required
stringAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
only_user_removed
optional
booleanExclude Directly Applied Only-

4.1.7.3 - 1.1

scpcli iam-identity-center account delete
--account_assignment_id <value>
--target_account_id <value>
--instance_id <value>
[--only_user_removed <value>]

Description

delete a specific account Assignment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
account_assignment_id
required
stringAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
only_user_removed
optional
booleanExclude Directly Applied Only-

4.1.7.4 - 1.0

scpcli iam-identity-center account delete
--account_assignment_id <value>
--target_account_id <value>
--instance_id <value>
[--only_user_removed <value>]

Description

delete a specific account Assignment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
account_assignment_id
required
stringAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
only_user_removed
optional
booleanExclude Directly Applied Only-

4.1.8 - DeleteBulkAccountAssignment

4.1.8.1 - 1.3

scpcli iam-identity-center account bulk delete
--target_account_id <value>
--instance_id <value>
[--account_assignment_ids <value>]
[--only_user_removed <value>]

Description

delete multiple account Assignment

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
account_assignment_ids
optional
arrayAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
only_user_removed
optional
booleanExclude Directly Applied Only-

4.1.8.2 - 1.2

scpcli iam-identity-center account bulk delete
--target_account_id <value>
--instance_id <value>
[--account_assignment_ids <value>]
[--only_user_removed <value>]

Description

delete multiple account Assignment

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
account_assignment_ids
optional
arrayAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
only_user_removed
optional
booleanExclude Directly Applied Only-

4.1.8.3 - 1.1

scpcli iam-identity-center account bulk delete
--target_account_id <value>
--instance_id <value>
[--account_assignment_ids <value>]
[--only_user_removed <value>]

Description

delete multiple account Assignment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
account_assignment_ids
optional
arrayAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
only_user_removed
optional
booleanExclude Directly Applied Only-

4.1.8.4 - 1.0

scpcli iam-identity-center account bulk delete
--target_account_id <value>
--instance_id <value>
[--account_assignment_ids <value>]
[--only_user_removed <value>]

Description

delete multiple account Assignment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
account_assignment_ids
optional
arrayAssignment IDb2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8
only_user_removed
optional
booleanExclude Directly Applied Only-

4.1.9 - DeleteBulkGroups

4.1.9.1 - 1.3

scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>

Description

delete groups

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
group_ids
required
arrayList of Group IDsgroup-12345

4.1.9.2 - 1.2

scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>

Description

delete groups

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
group_ids
required
arrayList of Group IDsgroup-12345

4.1.9.3 - 1.1

scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>

Description

delete groups

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
group_ids
required
arrayList of Group IDsgroup-12345

4.1.9.4 - 1.0

scpcli iam-identity-center group bulk delete
--instance_id <value>
--group_ids <value>

Description

delete groups

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
group_ids
required
arrayList of Group IDsgroup-12345

4.1.10 - DeleteBulkGroupUsers

4.1.10.1 - 1.3

scpcli iam-identity-center group user remove
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

remove users from the specific group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

4.1.10.2 - 1.2

scpcli iam-identity-center group user remove
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

remove users from the specific group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

4.1.10.3 - 1.1

scpcli iam-identity-center group user remove
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

remove users from the specific group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

4.1.10.4 - 1.0

scpcli iam-identity-center group user remove
--group_id <value>
--user_uuids <value>
--instance_id <value>

Description

remove users from the specific group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

4.1.11 - DeleteBulkUsers

4.1.11.1 - 1.3

scpcli iam-identity-center user bulk delete
--user_uuids <value>
--instance_id <value>

Description

delete bulk users

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

4.1.11.2 - 1.2

scpcli iam-identity-center user bulk delete
--user_uuids <value>
--instance_id <value>

Description

delete bulk users

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

4.1.11.3 - 1.1

scpcli iam-identity-center user bulk delete
--user_uuids <value>
--instance_id <value>

Description

delete bulk users

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

4.1.11.4 - 1.0

scpcli iam-identity-center user bulk delete
--user_uuids <value>
--instance_id <value>

Description

delete bulk users

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
user_uuids
required
arrayList of User IDsuser-12345
instance_id
required
stringInstance IDssoins-12345

4.1.12 - DeleteGroup

4.1.12.1 - 1.3

scpcli iam-identity-center group delete
--group_id <value>
--instance_id <value>

Description

delete a specific group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

4.1.12.2 - 1.2

scpcli iam-identity-center group delete
--group_id <value>
--instance_id <value>

Description

delete a specific group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

4.1.12.3 - 1.1

scpcli iam-identity-center group delete
--group_id <value>
--instance_id <value>

Description

delete a specific group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

4.1.12.4 - 1.0

scpcli iam-identity-center group delete
--group_id <value>
--instance_id <value>

Description

delete a specific group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

4.1.13 - DeleteInstance

4.1.13.1 - 1.3

scpcli iam-identity-center instance delete
--instance_id <value>

Description

delete a specific instance

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345

4.1.13.2 - 1.2

scpcli iam-identity-center instance delete
--instance_id <value>

Description

delete a specific instance

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345

4.1.13.3 - 1.1

scpcli iam-identity-center instance delete
--instance_id <value>

Description

delete a specific instance

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345

4.1.13.4 - 1.0

scpcli iam-identity-center instance delete
--instance_id <value>

Description

delete a specific instance

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345

4.1.14 - DeletePermissionSet

4.1.14.1 - 1.3

scpcli iam-identity-center permission set delete
--permission_set_id <value>
--instance_id <value>

Description

delete a specific permission set

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345

4.1.14.2 - 1.2

scpcli iam-identity-center permission set delete
--permission_set_id <value>
--instance_id <value>

Description

delete a specific permission set

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345

4.1.14.3 - 1.1

scpcli iam-identity-center permission set delete
--permission_set_id <value>
--instance_id <value>

Description

delete a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345

4.1.14.4 - 1.0

scpcli iam-identity-center permission set delete
--permission_set_id <value>
--instance_id <value>

Description

delete a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345

4.1.15 - DeletePermissionSetPolicies

4.1.15.1 - 1.3

scpcli iam-identity-center permission set delete policies
--permission_set_id <value>
--policy_ids <value>
--instance_id <value>

Description

delete policies to a specific permission set

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
policy_ids
required
array-
instance_id
required
stringInstance IDssoins-12345

4.1.15.2 - 1.2

scpcli iam-identity-center permission set delete policies
--permission_set_id <value>
--policy_ids <value>
--instance_id <value>

Description

delete policies to a specific permission set

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
policy_ids
required
array-
instance_id
required
stringInstance IDssoins-12345

4.1.15.3 - 1.1

scpcli iam-identity-center permission set delete policies
--permission_set_id <value>
--policy_ids <value>
--instance_id <value>

Description

delete policies to a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
policy_ids
required
array-
instance_id
required
stringInstance IDssoins-12345

4.1.15.4 - 1.0

scpcli iam-identity-center permission set delete policies
--permission_set_id <value>
--policy_ids <value>
--instance_id <value>

Description

delete policies to a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
policy_ids
required
array-
instance_id
required
stringInstance IDssoins-12345

4.1.16 - DeleteUser

4.1.16.1 - 1.3

scpcli iam-identity-center user delete
--user_uuid <value>
--instance_id <value>

Description

delete a specific user

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

4.1.16.2 - 1.2

scpcli iam-identity-center user delete
--user_uuid <value>
--instance_id <value>

Description

delete a specific user

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

4.1.16.3 - 1.1

scpcli iam-identity-center user delete
--user_uuid <value>
--instance_id <value>

Description

delete a specific user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

4.1.16.4 - 1.0

scpcli iam-identity-center user delete
--user_uuid <value>
--instance_id <value>

Description

delete a specific user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

4.1.17 - ListAccountAssignments

4.1.17.1 - 1.3

scpcli iam-identity-center list account assignment
--target_account_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--target_account_name <value>]
[--target_account_email <value>]
[--permission_set_id <value>]
[--principal_name <value>]
[--role_srn <value>]

Description

get account assignment list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
target_account_name
optional
stringAssigned Account NameAdmin Account
target_account_email
optional
stringAssigned Account Emailtarget_account@example.com
permission_set_id
optional
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_name
optional
stringPrincipal NameGROUP0407
role_srn
optional
stringRole SRNsrn:role:kr-j:1234:role/admin@example.com

Responses

NameDescriptionExample
instance_idInstance IDssoins-12345
permission_sets
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_namePrincipal NameGROUP0407
principal_typePrincipal TypeUSER
role_srnPermission Set DescriptionPermissions for administrators
target_account_emailAssigned Account Emailtarget_account@example.com
target_account_idAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
target_account_nameAssigned Account NameAdmin Account

4.1.17.2 - 1.2

scpcli iam-identity-center list account assignment
--target_account_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--target_account_name <value>]
[--target_account_email <value>]
[--permission_set_id <value>]
[--principal_name <value>]
[--role_srn <value>]

Description

get account assignment list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
target_account_name
optional
stringAssigned Account NameAdmin Account
target_account_email
optional
stringAssigned Account Emailtarget_account@example.com
permission_set_id
optional
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_name
optional
stringPrincipal NameGROUP0407
role_srn
optional
stringRole SRNsrn:role:kr-j:1234:role/admin@example.com

Responses

NameDescriptionExample
instance_idInstance IDssoins-12345
permission_sets
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_namePrincipal NameGROUP0407
principal_typePrincipal TypeUSER
role_srnPermission Set DescriptionPermissions for administrators
target_account_emailAssigned Account Emailtarget_account@example.com
target_account_idAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
target_account_nameAssigned Account NameAdmin Account

4.1.17.3 - 1.1

scpcli iam-identity-center list account assignment
--target_account_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--target_account_name <value>]
[--target_account_email <value>]
[--permission_set_id <value>]
[--principal_name <value>]
[--role_srn <value>]

Description

get account assignment list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
target_account_name
optional
stringAssigned Account NameAdmin Account
target_account_email
optional
stringAssigned Account Emailtarget_account@example.com
permission_set_id
optional
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_name
optional
stringPrincipal NameGROUP0407
role_srn
optional
stringRole SRNsrn:role:kr-j:1234:role/admin@example.com

Responses

NameDescriptionExample
instance_idInstance IDssoins-12345
permission_sets
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_namePrincipal NameGROUP0407
principal_typePrincipal TypeUSER
role_srnPermission Set DescriptionPermissions for administrators
target_account_emailAssigned Account Emailtarget_account@example.com
target_account_idAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
target_account_nameAssigned Account NameAdmin Account

4.1.17.4 - 1.0

scpcli iam-identity-center list account assignment
--target_account_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--target_account_name <value>]
[--target_account_email <value>]
[--permission_set_id <value>]
[--principal_name <value>]
[--role_srn <value>]

Description

get account assignment list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
target_account_id
required
stringAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
target_account_name
optional
stringAssigned Account NameAdmin Account
target_account_email
optional
stringAssigned Account Emailtarget_account@example.com
permission_set_id
optional
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
principal_name
optional
stringPrincipal NameGROUP0407
role_srn
optional
stringRole SRNsrn:role:kr-j:1234:role/admin@example.com

Responses

NameDescriptionExample
instance_idInstance IDssoins-12345
permission_sets
principal_idPrincipal ID138c2fc8c29a449dbfa8681f8f1d78e2
principal_namePrincipal NameGROUP0407
principal_typePrincipal TypeUSER
role_srnPermission Set DescriptionPermissions for administrators
target_account_emailAssigned Account Emailtarget_account@example.com
target_account_idAssigned Account ID3265ab469f0d406d83073da3e11e7a6c
target_account_nameAssigned Account NameAdmin Account

4.1.18 - ListGroups

4.1.18.1 - 1.3

scpcli iam-identity-center group list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--excluded_user_uuid <value>]
[--excluded_account_id <value>]

Description

get groups list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup NameAdmin_Group
excluded_user_uuid
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.18.2 - 1.2

scpcli iam-identity-center group list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--excluded_user_uuid <value>]
[--excluded_account_id <value>]

Description

get groups list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup NameAdmin_Group
excluded_user_uuid
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.18.3 - 1.1

scpcli iam-identity-center group list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--excluded_user_uuid <value>]
[--excluded_account_id <value>]

Description

get groups list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup NameAdmin_Group
excluded_user_uuid
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.18.4 - 1.0

scpcli iam-identity-center group list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--excluded_user_uuid <value>]
[--excluded_account_id <value>]

Description

get groups list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringGroup NameAdmin_Group
excluded_user_uuid
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.19 - ListGroupUsers

4.1.19.1 - 1.3

scpcli iam-identity-center group users list
--group_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]

Description

get group users list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
group_countNumber of Groups the User Belongs To2
groupsList of Groups the User Belongs To[{‘created_at’: ‘2025-07-03T12:05:11’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘39520424-440c-41c0-9b9c-f22b2129f6f9’, ‘modified_at’: ‘2025-07-03T12:05:11’, ‘modified_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ’name’: ‘admin’}, {‘created_at’: ‘2025-07-03T12:05:36’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘80c53fe1-4e27-4cce-92be-151cf0f2873e’, ‘modified_at’: ‘2025-07-07T05:16:58’, ‘modified_by’: ‘941e76c4b9424cd9b0ac3a12d5f4335d’, ’name’: ’test-group’}]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameReal NameJohn Doe
user_idUser Login IDjohndoe

4.1.19.2 - 1.2

scpcli iam-identity-center group users list
--group_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]

Description

get group users list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
group_countNumber of Groups the User Belongs To2
groupsList of Groups the User Belongs To[{‘created_at’: ‘2025-07-03T12:05:11’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘39520424-440c-41c0-9b9c-f22b2129f6f9’, ‘modified_at’: ‘2025-07-03T12:05:11’, ‘modified_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ’name’: ‘admin’}, {‘created_at’: ‘2025-07-03T12:05:36’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘80c53fe1-4e27-4cce-92be-151cf0f2873e’, ‘modified_at’: ‘2025-07-07T05:16:58’, ‘modified_by’: ‘941e76c4b9424cd9b0ac3a12d5f4335d’, ’name’: ’test-group’}]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameReal NameJohn Doe
user_idUser Login IDjohndoe

4.1.19.3 - 1.1

scpcli iam-identity-center group users list
--group_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]

Description

get group users list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
group_countNumber of Groups the User Belongs To2
groupsList of Groups the User Belongs To[{‘created_at’: ‘2025-07-03T12:05:11’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘39520424-440c-41c0-9b9c-f22b2129f6f9’, ‘modified_at’: ‘2025-07-03T12:05:11’, ‘modified_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ’name’: ‘admin’}, {‘created_at’: ‘2025-07-03T12:05:36’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘80c53fe1-4e27-4cce-92be-151cf0f2873e’, ‘modified_at’: ‘2025-07-07T05:16:58’, ‘modified_by’: ‘941e76c4b9424cd9b0ac3a12d5f4335d’, ’name’: ’test-group’}]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameReal NameJohn Doe
user_idUser Login IDjohndoe

4.1.19.4 - 1.0

scpcli iam-identity-center group users list
--group_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]

Description

get group users list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
group_countNumber of Groups the User Belongs To2
groupsList of Groups the User Belongs To[{‘created_at’: ‘2025-07-03T12:05:11’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘39520424-440c-41c0-9b9c-f22b2129f6f9’, ‘modified_at’: ‘2025-07-03T12:05:11’, ‘modified_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ’name’: ‘admin’}, {‘created_at’: ‘2025-07-03T12:05:36’, ‘created_by’: ‘a8b5d675f25341cea41eb4cd1979aa95’, ‘id’: ‘80c53fe1-4e27-4cce-92be-151cf0f2873e’, ‘modified_at’: ‘2025-07-07T05:16:58’, ‘modified_by’: ‘941e76c4b9424cd9b0ac3a12d5f4335d’, ’name’: ’test-group’}]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameReal NameJohn Doe
user_idUser Login IDjohndoe

4.1.20 - ListInstances

4.1.20.1 - 1.3

scpcli iam-identity-center instance list
[--size <value>]
[--page <value>]
[--sort <value>]

Description

get instances list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
stateState

4.1.20.2 - 1.2

scpcli iam-identity-center instance list
[--size <value>]
[--page <value>]
[--sort <value>]

Description

get instances list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
stateState

4.1.20.3 - 1.1

scpcli iam-identity-center instance list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

get instances list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringInstance NameMy Instance

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
stateState

4.1.20.4 - 1.0

scpcli iam-identity-center instance list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

get instances list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringInstance NameMy Instance

Responses

NameDescriptionExample
idInstance IDssoins-12345
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
stateState

4.1.21 - ListPermissionSetPolicies

4.1.21.1 - 1.3

scpcli iam-identity-center permission set get policies
--permission_set_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--category <value>]
[--name <value>]

Description

get policies to a specific permission set

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
category
optional
****Policy TypeINLINE_POLICY
name
optional
stringPermission Set

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
categoryPolicy TypeINLINE_POLICY
contentsJSON Document
namePolicy NamePolicyName
permission_set_idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1

4.1.21.2 - 1.2

scpcli iam-identity-center permission set get policies
--permission_set_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--category <value>]
[--name <value>]

Description

get policies to a specific permission set

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
category
optional
****Policy TypeINLINE_POLICY
name
optional
stringPermission Set

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
categoryPolicy TypeINLINE_POLICY
contentsJSON Document
namePolicy NamePolicyName
permission_set_idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1

4.1.21.3 - 1.1

scpcli iam-identity-center permission set get policies
--permission_set_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--category <value>]
[--name <value>]

Description

get policies to a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
category
optional
****Policy TypeINLINE_POLICY
name
optional
stringPermission Set

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
categoryPolicy TypeINLINE_POLICY
contentsJSON Document
namePolicy NamePolicyName
permission_set_idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1

4.1.21.4 - 1.0

scpcli iam-identity-center permission set get policies
--permission_set_id <value>
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--category <value>]
[--name <value>]

Description

get policies to a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
category
optional
****Policy TypeINLINE_POLICY
name
optional
stringPermission Set

Responses

NameDescriptionExample
idPolicy ID37f2e31ff86b415698d7e8eeafab445d
categoryPolicy TypeINLINE_POLICY
contentsJSON Document
namePolicy NamePolicyName
permission_set_idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1

4.1.22 - ListPermissionSets

4.1.22.1 - 1.3

scpcli iam-identity-center permission set list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

get permission sets list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPermission Set NamePermission Set

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.22.2 - 1.2

scpcli iam-identity-center permission set list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

get permission sets list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPermission Set NamePermission Set

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.22.3 - 1.1

scpcli iam-identity-center permission set list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

get permission sets list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPermission Set NamePermission Set

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
descriptionPermission Set DescriptionPermissions for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
stateState

4.1.22.4 - 1.0

scpcli iam-identity-center permission set list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

get permission sets list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPermission Set NamePermission Set

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
descriptionPermission Set DescriptionPermissions for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
stateState

4.1.23 - ListUsers

4.1.23.1 - 1.3

scpcli iam-identity-center user list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
[--excluded_group_id <value>]
[--excluded_account_id <value>]

Description

get users list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser Login IDjohndoe
excluded_group_id
optional
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
nameReal NameJohn Doe
user_idUser Login IDjohndoe

4.1.23.2 - 1.2

scpcli iam-identity-center user list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
[--excluded_group_id <value>]
[--excluded_account_id <value>]

Description

get users list

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser Login IDjohndoe
excluded_group_id
optional
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
nameReal NameJohn Doe
user_idUser Login IDjohndoe

4.1.23.3 - 1.1

scpcli iam-identity-center user list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
[--excluded_group_id <value>]
[--excluded_account_id <value>]

Description

get users list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser Login IDjohndoe
excluded_group_id
optional
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
nameReal NameJohn Doe
user_idUser Login IDjohndoe

4.1.23.4 - 1.0

scpcli iam-identity-center user list
--instance_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--user_id <value>]
[--excluded_group_id <value>]
[--excluded_account_id <value>]

Description

get users list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
user_id
optional
stringUser Login IDjohndoe
excluded_group_id
optional
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
excluded_account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
nameReal NameJohn Doe
user_idUser Login IDjohndoe

4.1.24 - SetGroup

4.1.24.1 - 1.3

scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]

Description

set a specific group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
name
optional
stringGroup NameAdmin_Group

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group

4.1.24.2 - 1.2

scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]

Description

set a specific group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
name
optional
stringGroup NameAdmin_Group

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group

4.1.24.3 - 1.1

scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]

Description

set a specific group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
name
optional
stringGroup NameAdmin_Group

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group

4.1.24.4 - 1.0

scpcli iam-identity-center group set
--group_id <value>
--instance_id <value>
[--description <value>]
[--name <value>]

Description

set a specific group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
description
optional
stringGroup DescriptionGroup for administrators
name
optional
stringGroup NameAdmin_Group

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group

4.1.25 - SetPermissionSet

4.1.25.1 - 1.3

scpcli iam-identity-center permission set set
--permission_set_id <value>
--instance_id <value>
[--description <value>]
[--session_duration <value>]

Description

set a specific permission set

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
description
optional
stringInstance DescriptionMy Instance Description
session_duration
optional
integerMaximum Session Duration3600

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.25.2 - 1.2

scpcli iam-identity-center permission set set
--permission_set_id <value>
--instance_id <value>
[--description <value>]
[--session_duration <value>]

Description

set a specific permission set

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
description
optional
stringInstance DescriptionMy Instance Description
session_duration
optional
integerMaximum Session Duration3600

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.25.3 - 1.1

scpcli iam-identity-center permission set set
--permission_set_id <value>
--instance_id <value>
[--description <value>]
[--session_duration <value>]

Description

set a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
description
optional
stringInstance DescriptionMy Instance Description
session_duration
optional
integerMaximum Session Duration3600

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.25.4 - 1.0

scpcli iam-identity-center permission set set
--permission_set_id <value>
--instance_id <value>
[--description <value>]
[--session_duration <value>]

Description

set a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
description
optional
stringInstance DescriptionMy Instance Description
session_duration
optional
integerMaximum Session Duration3600

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.26 - SetPermissionSetPolicies

4.1.26.1 - 1.3

scpcli iam-identity-center permission set set policies
--permission_set_id <value>
--instance_id <value>
[--custom_policies <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

set policies to a specific permission set

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
custom_policies
optional
arrayCustomer Managed Policy-
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy-

4.1.26.2 - 1.2

scpcli iam-identity-center permission set set policies
--permission_set_id <value>
--instance_id <value>
[--custom_policies <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

set policies to a specific permission set

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
custom_policies
optional
arrayCustomer Managed Policy-
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy-

4.1.26.3 - 1.1

scpcli iam-identity-center permission set set policies
--permission_set_id <value>
--instance_id <value>
[--customer_policies <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

set policies to a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
customer_policies
optional
arrayCustomer Managed Policy-
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy-

4.1.26.4 - 1.0

scpcli iam-identity-center permission set set policies
--permission_set_id <value>
--instance_id <value>
[--customer_policies <value>]
[--inline_policies <value>]
[--managed_policies <value>]

Description

set policies to a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345
customer_policies
optional
arrayCustomer Managed Policy-
inline_policies
optional
arrayInline Policy-
managed_policies
optional
arrayManaged Policy-

4.1.27 - SetUser

4.1.27.1 - 1.3

scpcli iam-identity-center user set
--user_uuid <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--manager <value>]
[--name <value>]
[--nation_id <value>]
[--phone_number <value>]
[--tz_id <value>]

Description

set a specific user

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
manager
optional
stringManagerAlice Smith
name
optional
stringReal NameJohn Doe
nation_id
optional
stringNationality ID+82
phone_number
optional
stringPhone Number010-1234-5678
tz_id
optional
stringTimezone IDAsia/Seoul

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

4.1.27.2 - 1.2

scpcli iam-identity-center user set
--user_uuid <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--manager <value>]
[--name <value>]
[--nation_id <value>]
[--phone_number <value>]
[--tz_id <value>]

Description

set a specific user

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
manager
optional
stringManagerAlice Smith
name
optional
stringReal NameJohn Doe
nation_id
optional
stringNationality ID+82
phone_number
optional
stringPhone Number010-1234-5678
tz_id
optional
stringTimezone IDAsia/Seoul

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

4.1.27.3 - 1.1

scpcli iam-identity-center user set
--user_uuid <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--manager <value>]
[--name <value>]
[--nation_id <value>]
[--phone_number <value>]
[--tz_id <value>]

Description

set a specific user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
manager
optional
stringManagerAlice Smith
name
optional
stringReal NameJohn Doe
nation_id
optional
stringNationality ID+82
phone_number
optional
stringPhone Number010-1234-5678
tz_id
optional
stringTimezone IDAsia/Seoul

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

4.1.27.4 - 1.0

scpcli iam-identity-center user set
--user_uuid <value>
--instance_id <value>
[--business_unit <value>]
[--department <value>]
[--description <value>]
[--email <value>]
[--employee_id <value>]
[--manager <value>]
[--name <value>]
[--nation_id <value>]
[--phone_number <value>]
[--tz_id <value>]

Description

set a specific user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345
business_unit
optional
stringBusiness UnitBusiness Unit A
department
optional
stringDepartmentDepartment X
description
optional
stringUser DescriptionDescription of John Doe
email
optional
stringUser Emailjohn.doe@example.com
employee_id
optional
stringEmployee IDemp-12345
manager
optional
stringManagerAlice Smith
name
optional
stringReal NameJohn Doe
nation_id
optional
stringNationality ID+82
phone_number
optional
stringPhone Number010-1234-5678
tz_id
optional
stringTimezone IDAsia/Seoul

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

4.1.28 - ShowGroup

4.1.28.1 - 1.3

scpcli iam-identity-center group show
--group_id <value>
--instance_id <value>

Description

show a specific group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.28.2 - 1.2

scpcli iam-identity-center group show
--group_id <value>
--instance_id <value>

Description

show a specific group

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.28.3 - 1.1

scpcli iam-identity-center group show
--group_id <value>
--instance_id <value>

Description

show a specific group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.28.4 - 1.0

scpcli iam-identity-center group show
--group_id <value>
--instance_id <value>

Description

show a specific group

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
group_id
required
stringGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idGroup ID138c2fc8c29a449dbfa8681f8f1d78e2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
descriptionGroup DescriptionGroup for administrators
instance_idInstance IDssoins-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameGroup NameAdmin_Group
user_countNumber of Users in the group1
usersList of Users in the Group[{‘id’: ‘6fdd2a6d-6f4f-4157-8259-5d55e7dd1269’, ’name’: ‘John Doe’, ‘user_id’: ‘johndoe’}]

4.1.29 - ShowInstance

4.1.29.1 - 1.3

scpcli iam-identity-center instance show
--instance_id <value>

Description

show a specific instance

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idInstance IDssoins-12345
account_idAccount ID1234ab567cd64769e8f9g490hi304891
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
delegated_account_idDelegated Account IDacc-2353
delegated_atDelegation Date2023-10-15 14:30:00
delegated_byDelegated Bysef2w3c8c29a449dbfa8681f8f1d78e2
descriptionInstance DescriptionMy Instance Description
identity_store_configIdentity Store Config{‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’}
identity_store_idIdentity Store IDd-12345
identity_store_typeIdentity Store Type
last_sync_atLast Sync Date2025-08-06 10:30:00
last_sync_statusLast Sync Status[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’]
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameInstance NameMy Instance
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
portPort443
public_ipPublic IP
regionRegionkr-west1
resource_nameResource Nameresource-name-1
resource_typeResource Type [instancepermission-set]
resource_type_display_nameResource Type Display NameVirtual Server
serviceServicevirtualserver
service_nameService NameVirtual Server
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO Start URLhttps://login.e.samsungsdscloud.com/d-12345
stateState

4.1.29.2 - 1.2

scpcli iam-identity-center instance show
--instance_id <value>

Description

show a specific instance

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idInstance IDssoins-12345
account_idAccount ID1234ab567cd64769e8f9g490hi304891
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
delegated_account_idDelegated Account IDacc-2353
delegated_atDelegation Date2023-10-15 14:30:00
delegated_byDelegated Bysef2w3c8c29a449dbfa8681f8f1d78e2
descriptionInstance DescriptionMy Instance Description
identity_store_configIdentity Store Config{‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’}
identity_store_idIdentity Store IDd-12345
identity_store_typeIdentity Store Type
last_sync_atLast Sync Date2025-08-06 10:30:00
last_sync_statusLast Sync Status[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’]
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameInstance NameMy Instance
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
resource_nameResource Nameresource-name-1
resource_typeResource Type [instancepermission-set]
resource_type_display_nameResource Type Display NameVirtual Server
serviceServicevirtualserver
service_nameService NameVirtual Server
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO Start URLhttps://login.e.samsungsdscloud.com/d-12345
stateState

4.1.29.3 - 1.1

scpcli iam-identity-center instance show
--instance_id <value>

Description

show a specific instance

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idInstance IDssoins-12345
account_idAccount ID1234ab567cd64769e8f9g490hi304891
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
delegated_account_idDelegated Account IDacc-2353
delegated_atDelegation Date2023-10-15 14:30:00
delegated_byDelegated Bysef2w3c8c29a449dbfa8681f8f1d78e2
descriptionInstance DescriptionMy Instance Description
identity_store_configIdentity Store Config{‘bind_credential’: ‘password’, ‘bind_dn’: ‘CN=Administrator,CN=Users,DC=test,DC=add’, ‘component_id’: ‘HYIK7LLKQL2MFK2K8Jb1ew’, ‘connection_url’: ’ldaps://test.subdomain.company.com:123’, ‘rdn_ldap_attribute’: ‘cn’, ‘user_object_classes’: ‘person, organizationalPerson, user’, ‘username_ldap_attribute’: ‘sAMAccountName’, ‘users_dn’: ‘OU=Employees,OU=Accounts,DC=sub,DC=org’}
identity_store_idIdentity Store IDd-12345
identity_store_typeIdentity Store Type
last_sync_atLast Sync Date2025-08-06 10:30:00
last_sync_statusLast Sync Status[‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’]
master_account_idMaster Account IDacc-12345
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameInstance NameMy Instance
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
regionRegionkr-west1
resource_nameResource Nameresource-name-1
resource_typeResource Type [instancepermission-set]
resource_type_display_nameResource Type Display NameVirtual Server
serviceServicevirtualserver
service_nameService NameVirtual Server
srnInstance SRNsrn:identity-center::prj-01234:kr-west-1::instance/ins-01234
sso_start_urlSSO Start URLhttps://login.e.samsungsdscloud.com/d-12345
stateState

4.1.30 - ShowPermissionSet

4.1.30.1 - 1.3

scpcli iam-identity-center permission set show
--permission_set_id <value>
--instance_id <value>

Description

show a specific permission set

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
account_id
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
resource_name
resource_type
resource_type_display_name
service
service_name
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.30.2 - 1.2

scpcli iam-identity-center permission set show
--permission_set_id <value>
--instance_id <value>

Description

show a specific permission set

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
account_id
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
custom_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
resource_name
resource_type
resource_type_display_name
service
service_name
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.30.3 - 1.1

scpcli iam-identity-center permission set show
--permission_set_id <value>
--instance_id <value>

Description

show a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
account_id
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
resource_name
resource_type
resource_type_display_name
service
service_name
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.30.4 - 1.0

scpcli iam-identity-center permission set show
--permission_set_id <value>
--instance_id <value>

Description

show a specific permission set

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
permission_set_id
required
stringPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idPermission Set IDe8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
account_id
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator Name
customer_policiesCustomer Managed Policy
descriptionPermission Set DescriptionPermissions for administrators
inline_policiesInline Policy
instance_idInstance IDssoins-12345
managed_policiesManaged Policy
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier Name
namePermission Set NamePermission Set
resource_name
resource_type
resource_type_display_name
service
service_name
session_durationMaximum Session Duration3600
srnPermission Set SRNsrn::::::permissionSet/${InstanceId}/${permissionId}
stateState

4.1.31 - ShowUser

4.1.31.1 - 1.3

scpcli iam-identity-center user show
--user_uuid <value>
--instance_id <value>

Description

show a specific user

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

4.1.31.2 - 1.2

scpcli iam-identity-center user show
--user_uuid <value>
--instance_id <value>

Description

show a specific user

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

4.1.31.3 - 1.1

scpcli iam-identity-center user show
--user_uuid <value>
--instance_id <value>

Description

show a specific user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

4.1.31.4 - 1.0

scpcli iam-identity-center user show
--user_uuid <value>
--instance_id <value>

Description

show a specific user

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
user_uuid
required
stringUser ID138c2fc8c29a449dbfa8681f8f1d78e2
instance_id
required
stringInstance IDssoins-12345

Responses

NameDescriptionExample
idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
business_unitBusiness UnitBusiness Unit A
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
creator_nameCreator NameJohn Doe
departmentDepartmentDepartment X
descriptionUser DescriptionDescription of John Doe
emailUser Emailjohn.doe@example.com
email_authenticatedEmail Authentication Status
employee_idEmployee IDemp-12345
groupsList of Groups
instance_idInstance IDssoins-12345
last_login_atLast Login Date2024-12-19 01:09:05.000
last_password_update_atLast Password Update Date2026-03-17T09:58:31.498976
managerManagerAlice Smith
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
modifier_nameModifier NameSmith
nameReal NameJohn Doe
nation_idNationality ID+82
passwordPassword
password_failed_countPassword Failure Count6
password_reuse_countPassword Reuse Limit Count6
phone_authenticatedPhone Authentication Status
phone_numberPhone Number010-1234-5678
temporary_passwordTemporary Password Status
tz_idTimezone IDAsia/Seoul
user_idUser Login IDjohndoe

5 - Logging&Audit

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Logging&Audit service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260223

5.1 - CLIs

5.1.1 - CreateTrail

5.1.1.1 - 1.1

scpcli loggingaudit trail create
--trail_save_type <value>
--trail_name <value>
--bucket_region <value>
--bucket_name <value>
--account_id <value>
[--iam_role_id <value>]
[--log_archive_account_id <value>]
[--log_group_name <value>]
[--log_type_total_yn <value>]
[--log_verification_yn <value>]
[--organization_trail_yn <value>]
[--region_names <value>]
[--region_total_yn <value>]
[--resource_type_total_yn <value>]
[--service_watch_yn <value>]
[--tag_create_requests <value>]
[--target_log_types <value>]
[--target_resource_types <value>]
[--target_users <value>]
[--trail_description <value>]
[--user_total_yn <value>]

Description

create a trail

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
trail_save_type
required
stringTrail save typeJSON
trail_name
required
stringTrail nameTestTrail01
bucket_region
required
stringBucket regionRegionOne
bucket_name
required
stringBucket nameTestBucket00
account_id
required
stringAccount IDACCOUNT_ID-ABCDEF1234
iam_role_id
optional
stringIam Role ID. Only for Service Watch Trail.(service_watch_yn = Y)IAM_ROLE_ID-ABCDEF1234
log_archive_account_id
optional
stringLog Archive Account ID. Only for Organization Trail.(organization_trail_yn = y)ACCOUNT_ID-ABCDEF1234
log_group_name
optional
stringLog Group Name. Only for Service Watch Trail.(service_watch_yn = Y)/scp/loggingaudit/trail/trailname-log-group-20260205120000
log_type_total_yn
optional
stringTarget log type total y/nN
log_verification_yn
optional
stringLog verification y/nN
organization_trail_yn
optional
stringOrganization trail y/nN
region_names
optional
arrayRegion name list-
region_total_yn
optional
stringTarget region total y/nY
resource_type_total_yn
optional
stringTarget resource type total y/nY
service_watch_yn
optional
stringService Watch y/nY
tag_create_requests
optional
arrayTag create requests{'key': '11', 'value': '22'}
target_log_types
optional
arrayTarget log type list-
target_resource_types
optional
arrayTarget resource type list-
target_users
optional
arrayTarget user list-
trail_description
optional
stringTrail descriptionThis is a test trail
user_total_yn
optional
stringTarget user total y/nY

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
iam_role_idIam Role IDIAM_ROLE_ID-ABCDEF1234
log_archive_account_idLog Archive Account IDACCOUNT_ID-ABCDEF1234
log_group_nameLog Group Name/scp/loggingaudit/trail/trailname-log-group-20260205120000
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_trail_ynOrganization trail y/nY
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
service_watch_ynService Watch y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2026-02-26T07:00:00Z
trail_batch_first_start_atTrail batch first start date2026-02-16T08:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2026-02-26T07:00:00Z
trail_batch_success_atTrail batch success date2026-02-26T07:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

5.1.1.2 - 1.0

scpcli loggingaudit trail create

Description

create a trail

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2026-02-26T07:00:00Z
trail_batch_first_start_atTrail batch first start date2026-02-16T08:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2026-02-26T07:00:00Z
trail_batch_success_atTrail batch success date2026-02-26T07:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

5.1.2 - DeleteTrail

5.1.2.1 - 1.1

scpcli loggingaudit trail delete
--trail_id <value>

Description

delete a specific trail

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

5.1.2.2 - 1.0

scpcli loggingaudit trail delete
--trail_id <value>

Description

delete a specific trail

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

5.1.3 - DownloadLogs

5.1.3.1 - 1.1

scpcli loggingaudit log file download
--time_zone_info <value>
--start_at <value>
--file_type <value>
--end_at <value>
[--product_name <value>]
[--region <value>]
[--resource_name <value>]
[--resource_type <value>]
[--root_resource_id <value>]
[--status <value>]
[--user_name <value>]

Description

download log file

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
time_zone_info
required
stringTimezone infoAsia/Seoul
start_at
required
stringQuery start date2025-11-28T08:00:00Z
file_type
required
stringDownload file typeJSON
end_at
required
stringQuery finish date2026-02-26T08:00:00Z
product_name
optional
stringProduct name-
region
optional
stringRegion name-
resource_name
optional
stringResource name-
resource_type
optional
stringResource type-
root_resource_id
optional
stringRoot resource ID-
status
optional
stringTask result-
user_name
optional
stringUsername-

Responses

NameDescriptionExample
EventTopicEvent type
RegionNameRegion name
ResourceIdResource ID
ResourceNameResource name
ResourceTypeResource type
WorkInfoEvent name
WorkResultTask result
WorkTimeWork time
WorkerEmailWorker email
WorkerIDWorker ID
WorkerNameWorker name

5.1.3.2 - 1.0

scpcli loggingaudit log file download
--time_zone_info <value>
--start_at <value>
--file_type <value>
--end_at <value>
[--product_name <value>]
[--region <value>]
[--resource_name <value>]
[--resource_type <value>]
[--root_resource_id <value>]
[--status <value>]
[--user_name <value>]

Description

download log file

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
time_zone_info
required
stringTimezone infoAsia/Seoul
start_at
required
stringQuery start date2025-11-28T08:00:00Z
file_type
required
stringDownload file typeJSON
end_at
required
stringQuery finish date2026-02-26T08:00:00Z
product_name
optional
stringProduct name-
region
optional
stringRegion name-
resource_name
optional
stringResource name-
resource_type
optional
stringResource type-
root_resource_id
optional
stringRoot resource ID-
status
optional
stringTask result-
user_name
optional
stringUsername-

Responses

NameDescriptionExample
EventTopicEvent type
RegionNameRegion name
ResourceIdResource ID
ResourceNameResource name
ResourceTypeResource type
WorkInfoEvent name
WorkResultTask result
WorkTimeWork time
WorkerEmailWorker email
WorkerIDWorker ID
WorkerNameWorker name

5.1.4 - ListLogs

5.1.4.1 - 1.1

scpcli loggingaudit log list
--end_at <value>
--start_at <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--resource_id <value>]
[--resource_name <value>]
[--resource_type <value>]
[--product_name <value>]
[--product_type <value>]
[--status <value>]
[--event_type <value>]
[--user_id <value>]
[--user_name <value>]
[--region <value>]
[--root_resource_id <value>]
[--service_type <value>]

Description

get log list

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
end_at
required
stringQuery finish date2026-02-26T08:00:00Z
start_at
required
stringQuery start date2025-11-28T08:00:00Z
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
resource_id
optional
stringResource ID-
resource_name
optional
stringResource name-
resource_type
optional
stringResource type-
product_name
optional
stringProduct name-
product_type
optional
stringProduct type-
status
optional
stringTask result-
event_type
optional
stringEvent type-
user_id
optional
stringUser ID-
user_name
optional
stringUsername-
region
optional
stringRegion name-
root_resource_id
optional
stringRoot resource ID-
service_type
optional
stringService type-

Responses

NameDescriptionExample
idLog IDID-A1B2C3D4E5F6G7H8I9J0
account_idAccount IDACCOUNT_ID-ABCDEF1234
event_nameEvent namescp-extension.event.create
event_typeEvent typescp-extension.event.create
product_nameProduct namescp-extension
product_typeProduct typescp-extension
regionRegion nameRegionOne
request_user_nameUsernameHong Gildong
resource_idResource IDRESOURCE_ID-ABCDEF1234
resource_nameResource nameRESOURCE_NAME-ABCDEF1234
resource_typeResource typescp-extension
role_nameUsernameTester
statusTask resultSuccess
timestampTimestamp2026-02-26T08:00:00Z
typeTypeROLE
user_idUser IDUSER_ID-ABCDEF1234

5.1.4.2 - 1.0

scpcli loggingaudit log list
--end_at <value>
--start_at <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--resource_id <value>]
[--resource_name <value>]
[--resource_type <value>]
[--product_name <value>]
[--product_type <value>]
[--status <value>]
[--event_type <value>]
[--user_id <value>]
[--user_name <value>]
[--region <value>]
[--root_resource_id <value>]
[--service_type <value>]

Description

get log list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
end_at
required
stringQuery finish date2026-02-26T08:00:00Z
start_at
required
stringQuery start date2025-11-28T08:00:00Z
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
resource_id
optional
stringResource ID-
resource_name
optional
stringResource name-
resource_type
optional
stringResource type-
product_name
optional
stringProduct name-
product_type
optional
stringProduct type-
status
optional
stringTask result-
event_type
optional
stringEvent type-
user_id
optional
stringUser ID-
user_name
optional
stringUsername-
region
optional
stringRegion name-
root_resource_id
optional
stringRoot resource ID-
service_type
optional
stringService type-

Responses

NameDescriptionExample
idLog IDID-A1B2C3D4E5F6G7H8I9J0
account_idAccount IDACCOUNT_ID-ABCDEF1234
event_nameEvent namescp-extension.event.create
event_typeEvent typescp-extension.event.create
product_nameProduct namescp-extension
product_typeProduct typescp-extension
regionRegion nameRegionOne
request_user_nameUsernameHong Gildong
resource_idResource IDRESOURCE_ID-ABCDEF1234
resource_nameResource nameRESOURCE_NAME-ABCDEF1234
resource_typeResource typescp-extension
role_nameUsernameTester
statusTask resultSuccess
timestampTimestamp2026-02-26T08:00:00Z
typeTypeROLE
user_idUser IDUSER_ID-ABCDEF1234

5.1.5 - ListTrails

5.1.5.1 - 1.1

scpcli loggingaudit trail list
[--size <value>]
[--page <value>]
[--sort <value>]
[--trail_name <value>]
[--bucket_name <value>]
[--state <value>]
[--resource_type <value>]

Description

get trails list

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
trail_name
optional
stringTrail name-
bucket_name
optional
stringBucket name-
state
optional
stringTrail state-
resource_type
optional
stringResource type-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
iam_role_idIam Role IDIAM_ROLE_ID-ABCDEF1234
log_archive_account_idLog Archive Account IDACCOUNT_ID-ABCDEF1234
log_group_nameLog Group Name/scp/loggingaudit/trail/trailname-log-group-20260205120000
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_trail_ynOrganization trail y/nY
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
service_watch_ynService Watch y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2026-02-26T07:00:00Z
trail_batch_first_start_atTrail batch first start date2026-02-16T08:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2026-02-26T07:00:00Z
trail_batch_success_atTrail batch success date2026-02-26T07:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

5.1.5.2 - 1.0

scpcli loggingaudit trail list
[--size <value>]
[--page <value>]
[--sort <value>]
[--trail_name <value>]
[--bucket_name <value>]
[--state <value>]
[--resource_type <value>]

Description

get trails list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
trail_name
optional
stringTrail name-
bucket_name
optional
stringBucket name-
state
optional
stringTrail state-
resource_type
optional
stringResource type-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2026-02-26T07:00:00Z
trail_batch_first_start_atTrail batch first start date2026-02-16T08:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2026-02-26T07:00:00Z
trail_batch_success_atTrail batch success date2026-02-26T07:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

5.1.6 - SetTrail

5.1.6.1 - 1.1

scpcli loggingaudit trail set
--trail_id <value>
[--iam_role_id <value>]
[--log_group_name <value>]
[--log_type_total_yn <value>]
[--log_verification_yn <value>]
[--organization_trail_yn <value>]
[--region_names <value>]
[--region_total_yn <value>]
[--resource_type_total_yn <value>]
[--service_watch_yn <value>]
[--target_log_types <value>]
[--target_resource_types <value>]
[--target_users <value>]
[--trail_description <value>]
[--trail_save_type <value>]
[--user_total_yn <value>]

Description

set a specific trail

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-
iam_role_id
optional
stringIam Role IDIAM_ROLE_ID-ABCDEF1234
log_group_name
optional
stringLog Group Name/scp/loggingaudit/trail/trailname-log-group-20260205120000
log_type_total_yn
optional
stringTarget log type total y/nN
log_verification_yn
optional
stringLog verification y/nN
organization_trail_yn
optional
stringOrganization trail y/nY
region_names
optional
arrayRegion name list-
region_total_yn
optional
stringTarget region total y/nY
resource_type_total_yn
optional
stringTarget resource type total y/nY
service_watch_yn
optional
stringService Watch y/nY
target_log_types
optional
arrayTarget log type list-
target_resource_types
optional
arrayTarget resource type list-
target_users
optional
arrayTarget user list-
trail_description
optional
stringTrail descriptionThis is a test trail
trail_save_type
optional
stringTrail save typeJSON
user_total_yn
optional
stringTarget user total y/nY

5.1.6.2 - 1.0

scpcli loggingaudit trail set
--trail_id <value>
[--log_type_total_yn <value>]
[--log_verification_yn <value>]
[--region_names <value>]
[--region_total_yn <value>]
[--resource_type_total_yn <value>]
[--target_log_types <value>]
[--target_resource_types <value>]
[--target_users <value>]
[--trail_description <value>]
[--trail_save_type <value>]
[--user_total_yn <value>]

Description

set a specific trail

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-
log_type_total_yn
optional
stringTarget log type total y/nN
log_verification_yn
optional
stringLog verification y/nN
region_names
optional
arrayRegion name list-
region_total_yn
optional
stringTarget region total y/nY
resource_type_total_yn
optional
stringTarget resource type total y/nY
target_log_types
optional
arrayTarget log type list-
target_resource_types
optional
arrayTarget resource type list-
target_users
optional
arrayTarget user list-
trail_description
optional
stringTrail descriptionThis is a test trail
trail_save_type
optional
stringTrail save typeJSON
user_total_yn
optional
stringTarget user total y/nY

5.1.7 - ShowLog

5.1.7.1 - 1.1

scpcli loggingaudit log show
--logging_id <value>

Description

show a specific log

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
logging_id
required
stringLog ID-

Responses

NameDescriptionExample
idLog IDID-A1B2C3D4E5F6G7H8I9J0
account_idAccount IDACCOUNT_ID-ABCDEF1234
detailsAudit detail contents(JSON String)
event_nameEvent namescp-extension.event.create
event_typeEvent typescp-extension.event.create
product_nameProduct namescp-extension
product_typeProduct typescp-extension
regionRegion nameRegionOne
request_user_nameUsernameHong Gildong
resource_idResource IDRESOURCE_ID-ABCDEF1234
resource_nameResource nameRESOURCE_NAME-ABCDEF1234
resource_typeResource typescp-extension
role_nameUsernameTester
statusTask resultSuccess
timestampTimestamp2026-02-26T08:00:00Z
typeTypeROLE
user_idUser IDUSER_ID-ABCDEF1234

5.1.7.2 - 1.0

scpcli loggingaudit log show
--logging_id <value>

Description

show a specific log

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
logging_id
required
stringLog ID-

Responses

NameDescriptionExample
idLog IDID-A1B2C3D4E5F6G7H8I9J0
account_idAccount IDACCOUNT_ID-ABCDEF1234
detailsAudit detail contents(JSON String)
event_nameEvent namescp-extension.event.create
event_typeEvent typescp-extension.event.create
product_nameProduct namescp-extension
product_typeProduct typescp-extension
regionRegion nameRegionOne
request_user_nameUsernameHong Gildong
resource_idResource IDRESOURCE_ID-ABCDEF1234
resource_nameResource nameRESOURCE_NAME-ABCDEF1234
resource_typeResource typescp-extension
role_nameUsernameTester
statusTask resultSuccess
timestampTimestamp2026-02-26T08:00:00Z
typeTypeROLE
user_idUser IDUSER_ID-ABCDEF1234

5.1.8 - ShowTrail

5.1.8.1 - 1.1

scpcli loggingaudit trail show
--trail_id <value>

Description

show a specific trail

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
iam_role_idIam Role IDIAM_ROLE_ID-ABCDEF1234
log_archive_account_idLog Archive Account IDACCOUNT_ID-ABCDEF1234
log_group_nameLog Group Name/scp/loggingaudit/trail/trailname-log-group-20260205120000
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_trail_ynOrganization trail y/nY
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
service_watch_ynService Watch y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2026-02-26T07:00:00Z
trail_batch_first_start_atTrail batch first start date2026-02-16T08:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2026-02-26T07:00:00Z
trail_batch_success_atTrail batch success date2026-02-26T07:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

5.1.8.2 - 1.0

scpcli loggingaudit trail show
--trail_id <value>

Description

show a specific trail

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2026-02-26T07:00:00Z
trail_batch_first_start_atTrail batch first start date2026-02-16T08:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2026-02-26T07:00:00Z
trail_batch_success_atTrail batch success date2026-02-26T07:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

5.1.9 - StartTrail

5.1.9.1 - 1.1

scpcli loggingaudit trail start
--trail_id <value>

Description

start a specific trail

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
iam_role_idIam Role IDIAM_ROLE_ID-ABCDEF1234
log_archive_account_idLog Archive Account IDACCOUNT_ID-ABCDEF1234
log_group_nameLog Group Name/scp/loggingaudit/trail/trailname-log-group-20260205120000
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_trail_ynOrganization trail y/nY
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
service_watch_ynService Watch y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2026-02-26T07:00:00Z
trail_batch_first_start_atTrail batch first start date2026-02-16T08:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2026-02-26T07:00:00Z
trail_batch_success_atTrail batch success date2026-02-26T07:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

5.1.9.2 - 1.0

scpcli loggingaudit trail start
--trail_id <value>

Description

start a specific trail

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2026-02-26T07:00:00Z
trail_batch_first_start_atTrail batch first start date2026-02-16T08:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2026-02-26T07:00:00Z
trail_batch_success_atTrail batch success date2026-02-26T07:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

5.1.10 - StopTrail

5.1.10.1 - 1.1

scpcli loggingaudit trail stop
--trail_id <value>

Description

stop a specific trail

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
iam_role_idIam Role IDIAM_ROLE_ID-ABCDEF1234
log_archive_account_idLog Archive Account IDACCOUNT_ID-ABCDEF1234
log_group_nameLog Group Name/scp/loggingaudit/trail/trailname-log-group-20260205120000
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
organization_trail_ynOrganization trail y/nY
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
service_watch_ynService Watch y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2026-02-26T07:00:00Z
trail_batch_first_start_atTrail batch first start date2026-02-16T08:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2026-02-26T07:00:00Z
trail_batch_success_atTrail batch success date2026-02-26T07:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

5.1.10.2 - 1.0

scpcli loggingaudit trail stop
--trail_id <value>

Description

stop a specific trail

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
trail_id
required
stringTrail ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDACCOUNT_ID-ABCDEF1234
account_nameAccount nameTest Account
bucket_nameBucket nameBucket001
bucket_regionBucket regionRegionOne
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
created_user_idCreated user IDkim.samsung@samsung.com
del_ynDelete y/nN
log_type_total_ynTarget log type total y/nY
log_verification_ynLog verification y/nN
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_namesRegion name list[]
region_total_ynTarget region total y/nY
resource_type_total_ynTarget resource type total y/nY
stateTrail stateACTIVE
target_log_typesTarget log type list[]
target_resource_typesTarget resource type list[]
target_usersTarget user list[]
trail_batch_end_atTrail batch end date2026-02-26T07:00:00Z
trail_batch_first_start_atTrail batch first start date2026-02-16T08:00:00Z
trail_batch_last_stateTrail batch last statesuccess
trail_batch_start_atTrail batch start date2026-02-26T07:00:00Z
trail_batch_success_atTrail batch success date2026-02-26T07:00:00Z
trail_descriptionTrail descriptiontest trail
trail_nameTrail nameTrail-0001
trail_save_typeTrail save typeJSON
user_total_ynTarget user total y/nY

6 - Network Logging

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Network Logging service and how to call CLI. The output is formatted as a JSON string

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.0CURRENT-

6.1 - CLIs

6.1.1 - Create Network Logging Storage

6.1.1.1 - 1.0

scpcli network-logging network-logging-storage create
--resource_type <value>
--bucket_name <value>

Description

Create Network Logging Storage.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
stringResource Type-
bucket_name
required
stringStorage Bucket Name-

Responses

NameDescriptionExample
idNetwork Logging Storage ID
account_idAccount ID
bucket_nameStorage Bucket Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
resource_typeResource Type

6.1.2 - Delete Network Logging Storage

6.1.2.1 - 1.0

scpcli network-logging network-logging-storage delete
--network_logging_storage_id <value>

Description

Delete Network Logging Storage.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
network_logging_storage_id
required
stringNetwork Logging Storage ID-

6.1.3 - List Network Logging Configurations

6.1.3.1 - 1.0

scpcli network-logging network-logging-configuration list
--resource_type <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--resource_id <value>]
[--resource_name <value>]

Description

Get Network Logging Configuration list.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
****Resource Type-
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
resource_id
optional
stringResource ID-
resource_name
optional
stringResource Name-

Responses

NameDescriptionExample
idNetwork Logging Configuration ID
account_idAccount ID
bucket_nameStorage Bucket Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
down_interfaceDownlink Interface
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
resource_idResource ID
resource_nameResource Name
resource_typeResource Type
security_group_log_idSecurity Group Log ID
up_interfaceUplink Interface

6.1.4 - List Network Logging Storages

6.1.4.1 - 1.0

scpcli network-logging network-logging-storage list
--resource_type <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]

Description

Get Network Logging Storage list.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
****Resource Type-
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idNetwork Logging Storage ID
account_idAccount ID
bucket_nameStorage Bucket Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
resource_typeResource Type

7 - Organization

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Organization service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.2CURRENT-
1.1DEPRECATED20260531
1.0DEPRECATED20251231

7.1 - CLIs

7.1.1 - AcceptInvitation

7.1.1.1 - 1.2

scpcli organization invitation accept
--invitation_id <value>

Description

accept a specific invitation

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
invitation_id
required
stringInvitation ID138c2fc8c29a449dbfa8681f8f1d78e2

7.1.1.2 - 1.1

scpcli organization invitation accept
--invitation_id <value>

Description

accept a specific invitation

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
invitation_id
required
stringInvitation ID138c2fc8c29a449dbfa8681f8f1d78e2

7.1.1.3 - 1.0

scpcli organization invitation accept
--invitation_id <value>

Description

accept a specific invitation

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
invitation_id
required
stringInvitation ID138c2fc8c29a449dbfa8681f8f1d78e2

7.1.2 - AttachPolicyBindings

7.1.2.1 - 1.2

scpcli organization policy attach
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]

Description

attach policy bindings

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
target_ids
required
arrayTarget Infoou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
policy_ids
required
arrayControl Policy List IDf98e76d54c32b10a9z8y7x6w5v4u3
entity
required
stringEntity TypePOLICY
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
error_codeError CodeConflict
failed_causedFailure CauseAccount 482d111a302547fbbd11ee0141ea23bb is not found
failed_idFailed IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
response

7.1.2.2 - 1.1

scpcli organization policy attach
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]

Description

attach policy bindings

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
target_ids
required
arrayTarget Infoou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
policy_ids
required
arrayControl Policy List IDf98e76d54c32b10a9z8y7x6w5v4u3
entity
required
stringEntity TypePOLICY
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
error_codeError CodeConflict
failed_causedFailure CauseAccount 482d111a302547fbbd11ee0141ea23bb is not found
failed_idFailed IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
response

7.1.2.3 - 1.0

scpcli organization policy attach
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]

Description

attach policy bindings

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
target_ids
required
arrayTarget Infoou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
policy_ids
required
arrayControl Policy List IDf98e76d54c32b10a9z8y7x6w5v4u3
entity
required
stringEntity TypePOLICY
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
error_codeError CodeConflict
failed_causedFailure CauseAccount 482d111a302547fbbd11ee0141ea23bb is not found
failed_idFailed IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
response

7.1.3 - CancelInvitations

7.1.3.1 - 1.2

scpcli organization invitation cancel
--ids <value>
[--organization_id <value>]

Description

cancel invitations

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
ids
required
arrayInvitation ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.3.2 - 1.1

scpcli organization invitation cancel
--ids <value>
[--organization_id <value>]

Description

cancel invitations

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
ids
required
arrayInvitation ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.3.3 - 1.0

scpcli organization invitation cancel
--ids <value>
[--organization_id <value>]

Description

cancel invitations

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
ids
required
arrayInvitation ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.4 - CreateAccount

7.1.4.1 - 1.2

scpcli organization account create
--role_name <value>
--organization_id <value>
--name <value>
--login_id <value>

Description

create a account

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
role_name
required
stringRole NameOrganizationAccountAccessRole
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
required
stringAccount Namescore-account
login_id
required
stringLogin IDlog-archive@samsung.com

Responses

NameDescriptionExample
failedAccount Create Fail Info
successAccount Create Success Info

7.1.4.2 - 1.1

scpcli organization account create
--role_name <value>
--organization_id <value>
--name <value>
--login_id <value>

Description

create a account

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
role_name
required
stringRole NameOrganizationAccountAccessRole
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
required
stringAccount Namescore-account
login_id
required
stringLogin IDlog-archive@samsung.com

Responses

NameDescriptionExample
failedAccount Create Fail Info
successAccount Create Success Info

7.1.4.3 - 1.0

scpcli organization account create
--role_name <value>
--organization_id <value>
--name <value>
--login_id <value>

Description

create a account

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
role_name
required
stringRole NameOrganizationAccountAccessRole
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
required
stringAccount Namescore-account
login_id
required
stringLogin IDlog-archive@samsung.com

Responses

NameDescriptionExample
failedAccount Create Fail Info
successAccount Create Success Info

7.1.5 - CreateDelegationPolicy

7.1.5.1 - 1.2

scpcli organization delegation policy create
[--organization_id <value>]
[--statement <value>]
[--version <value>]

Description

create a delegation policy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

Responses

NameDescriptionExample
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
documentDelegation Policy Document{‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.5.2 - 1.1

scpcli organization delegation policy create
[--organization_id <value>]
[--statement <value>]
[--version <value>]

Description

create a delegation policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

Responses

NameDescriptionExample
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
documentDelegation Policy Document{‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.5.3 - 1.0

scpcli organization delegation policy create
[--organization_id <value>]
[--statement <value>]
[--version <value>]

Description

create a delegation policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

Responses

NameDescriptionExample
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
documentDelegation Policy Document{‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.6 - CreateInvitation

7.1.6.1 - 1.2

scpcli organization invitation create
--target_login_ids <value>
[--organization_id <value>]

Description

create an invitation

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
target_login_ids
required
arrayInvitation Receiver Account Email Listscore-1@samsung.com
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
error_codeError CodeInvitation.AlreadySentError
failed_causedFailure ReasonAccount b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found
failed_idOrganization Invitation Fail Login ID List[‘score-1@samsung.com’]
response

7.1.6.2 - 1.1

scpcli organization invitation create
--target_login_ids <value>
[--organization_id <value>]

Description

create an invitation

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
target_login_ids
required
arrayInvitation Receiver Account Email Listscore-1@samsung.com
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
error_codeError CodeInvitation.AlreadySentError
failed_causedFailure ReasonAccount b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found
failed_idOrganization Invitation Fail Login ID List[‘score-1@samsung.com’]
response

7.1.6.3 - 1.0

scpcli organization invitation create
--target_login_ids <value>
[--organization_id <value>]

Description

create an invitation

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
target_login_ids
required
arrayInvitation Receiver Account Email Listscore-1@samsung.com
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
error_codeError CodeInvitation.AlreadySentError
failed_causedFailure ReasonAccount b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found
failed_idOrganization Invitation Fail Login ID List[‘score-1@samsung.com’]
response

7.1.7 - CreateOrganization

7.1.7.1 - 1.2

scpcli organization organization create
--name <value>

Description

create a organization

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringOrganization NameMy Organization

Responses

NameDescriptionExample
idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
delegation_account_idDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_emailMaster Account Emailadmin@example.com
master_account_idMaster Account ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameOrganization NameMy Organization
root_unit_idRoot Unit IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
srnOrganization SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_ynControl Policy Usage YNTrue

7.1.7.2 - 1.1

scpcli organization organization create
--name <value>

Description

create a organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
name
required
stringOrganization NameMy Organization

Responses

NameDescriptionExample
idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
delegation_account_idDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_emailMaster Account Emailadmin@example.com
master_account_idMaster Account ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameOrganization NameMy Organization
root_unit_idRoot Unit IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
srnOrganization SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_ynControl Policy Usage YNTrue

7.1.7.3 - 1.0

scpcli organization organization create
--name <value>

Description

create a organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringOrganization NameMy Organization

Responses

NameDescriptionExample
idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
delegation_account_idDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_emailMaster Account Emailadmin@example.com
master_account_idMaster Account ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameOrganization NameMy Organization
root_unit_idRoot Unit IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
srnOrganization SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_ynControl Policy Usage YNTrue

7.1.8 - CreateOrganizationUnit

7.1.8.1 - 1.2

scpcli organization organization unit create
--name <value>
[--description <value>]
[--organization_id <value>]
[--parent_unit_id <value>]
[--policy_ids <value>]

Description

create an organization unit

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringOrganization Unit Namescore-organization-unit
description
optional
stringOrganization Unit DescriptionScore Organization Unit
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_id
optional
stringRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
policy_ids
optional
arrayControl Policy List IDf98e76d54c32b10a9z8y7x6w5v4u3

Responses

NameDescriptionExample
organization_unitOrganization Unit Info

7.1.8.2 - 1.1

scpcli organization organization unit create
--name <value>
[--description <value>]
[--organization_id <value>]
[--parent_unit_id <value>]
[--policy_ids <value>]

Description

create an organization unit

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
name
required
stringOrganization Unit Namescore-organization-unit
description
optional
stringOrganization Unit DescriptionScore Organization Unit
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_id
optional
stringRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
policy_ids
optional
arrayControl Policy List IDf98e76d54c32b10a9z8y7x6w5v4u3

Responses

NameDescriptionExample
organization_unitOrganization Unit Info

7.1.8.3 - 1.0

scpcli organization organization unit create
--name <value>
[--description <value>]
[--organization_id <value>]
[--parent_unit_id <value>]
[--policy_ids <value>]

Description

create an organization unit

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringOrganization Unit Namescore-organization-unit
description
optional
stringOrganization Unit DescriptionScore Organization Unit
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_id
optional
stringRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
policy_ids
optional
arrayControl Policy List IDf98e76d54c32b10a9z8y7x6w5v4u3

Responses

NameDescriptionExample
organization_unitOrganization Unit Info

7.1.9 - CreateServiceControlPolicy

7.1.9.1 - 1.2

scpcli organization service control policy create
--organization_id <value>
--name <value>
--description <value>
[--type <value>]
[--statement <value>]
[--version <value>]

Description

create a service control policy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
required
stringService Control Policy NameMyPolicy
description
required
stringPolicy DescriptionThis is an example policy.
type
optional
stringService Control Policy TypeMANAGED
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

Responses

NameDescriptionExample
idService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
categoryPolicy CategorySCP
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
descriptionPolicy DescriptionThis is an example policy.
documentPolicy Document{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameService Control Policy NameMyPolicy
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
service_nameService NameOrganization
sourcePolicy Creation SubjectORGANIZATION
srnPolicy SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2
statePolicy StateACTIVE
typeService Control Policy TypeMANAGED

7.1.9.2 - 1.1

scpcli organization service control policy create
--organization_id <value>
--name <value>
--description <value>
[--type <value>]
[--statement <value>]
[--version <value>]

Description

create a service control policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
required
stringService Control Policy NameMyPolicy
description
required
stringPolicy DescriptionThis is an example policy.
type
optional
stringService Control Policy TypeMANAGED
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

Responses

NameDescriptionExample
idService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
categoryPolicy CategorySCP
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
descriptionPolicy DescriptionThis is an example policy.
documentPolicy Document{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameService Control Policy NameMyPolicy
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
service_nameService NameOrganization
sourcePolicy Creation SubjectORGANIZATION
srnPolicy SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2
statePolicy StateACTIVE
typeService Control Policy TypeMANAGED

7.1.9.3 - 1.0

scpcli organization service control policy create
--organization_id <value>
--name <value>
--description <value>
[--type <value>]
[--statement <value>]
[--version <value>]

Description

create a service control policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
required
stringService Control Policy NameMyPolicy
description
required
stringPolicy DescriptionThis is an example policy.
type
optional
stringService Control Policy TypeMANAGED
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

Responses

NameDescriptionExample
idService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
categoryPolicy CategorySCP
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
descriptionPolicy DescriptionThis is an example policy.
documentPolicy Document{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameService Control Policy NameMyPolicy
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
service_nameService NameOrganization
sourcePolicy Creation SubjectORGANIZATION
srnPolicy SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2
statePolicy StateACTIVE
typeService Control Policy TypeMANAGED

7.1.10 - DeclineInvitation

7.1.10.1 - 1.2

scpcli organization invitation decline
--invitation_id <value>

Description

decline a specific invitation

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
invitation_id
required
stringInvitation ID138c2fc8c29a449dbfa8681f8f1d78e2

7.1.10.2 - 1.1

scpcli organization invitation decline
--invitation_id <value>

Description

decline a specific invitation

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
invitation_id
required
stringInvitation ID138c2fc8c29a449dbfa8681f8f1d78e2

7.1.10.3 - 1.0

scpcli organization invitation decline
--invitation_id <value>

Description

decline a specific invitation

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
invitation_id
required
stringInvitation ID138c2fc8c29a449dbfa8681f8f1d78e2

7.1.11 - DeleteAccount

7.1.11.1 - 1.2

scpcli organization account delete
--account_id <value>
[--organization_id <value>]

Description

Delete a specific account

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
account_id
required
stringOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.12 - DeleteDelegationPolicy

7.1.12.1 - 1.2

scpcli organization delegation policy delete
[--organization_id <value>]

Description

delete a specific delegation policy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.12.2 - 1.1

scpcli organization delegation policy delete
[--organization_id <value>]

Description

delete a specific delegation policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.12.3 - 1.0

scpcli organization delegation policy delete
[--organization_id <value>]

Description

delete a specific delegation policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.13 - DeleteOrganization

7.1.13.1 - 1.2

scpcli organization organization delete
--organization_id <value>

Description

delete a specific organization

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.13.2 - 1.1

scpcli organization organization delete
--organization_id <value>

Description

delete a specific organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.13.3 - 1.0

scpcli organization organization delete
--organization_id <value>

Description

delete a specific organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.14 - DeleteOrganizationUnits

7.1.14.1 - 1.2

scpcli organization organization unit delete
--ids <value>
[--organization_id <value>]

Description

delete organization units

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
ids
required
arrayOrganization Unit ID Listou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.14.2 - 1.1

scpcli organization organization unit delete
--ids <value>
[--organization_id <value>]

Description

delete organization units

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
ids
required
arrayOrganization Unit ID Listou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.14.3 - 1.0

scpcli organization organization unit delete
--ids <value>
[--organization_id <value>]

Description

delete organization units

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
ids
required
arrayOrganization Unit ID Listou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.15 - DeleteServiceControlPolicies

7.1.15.1 - 1.2

scpcli organization service control policy delete
--organization_id <value>
--ids <value>

Description

delete service control policies

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
ids
required
arrayService Control Policy List ID138c2fc8c29a449dbfa8681f8f1d78e2

7.1.15.2 - 1.1

scpcli organization service control policy delete
--organization_id <value>
--ids <value>

Description

delete service control policies

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
ids
required
arrayService Control Policy List ID138c2fc8c29a449dbfa8681f8f1d78e2

7.1.15.3 - 1.0

scpcli organization service control policy delete
--organization_id <value>
--ids <value>

Description

delete service control policies

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
ids
required
arrayService Control Policy List ID138c2fc8c29a449dbfa8681f8f1d78e2

7.1.16 - LeaveOrganization

7.1.16.1 - 1.2

scpcli organization organization leave
--organization_id <value>

Description

leave a specific organization

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.16.2 - 1.1

scpcli organization organization leave
--organization_id <value>

Description

leave a specific organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.16.3 - 1.0

scpcli organization organization leave
--organization_id <value>

Description

leave a specific organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.17 - ListAccountInvitations

7.1.17.1 - 1.2

scpcli organization account invitation list

Description

get account invitation list

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
expired_timeInvitation Expired Datetime2024-04-30T12:34:56.789Z
master_account_emailMaster Account Emailadmin@example.com
master_account_idMaster Account Name9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_login_idLogin IDlog-archive@samsung.com
master_account_nameMaster Account NameCoreKim
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
organization_nameOrganization NameMy Organization
requested_timeInvitation Request Datetime2024-04-17T12:34:56.789Z
stateInvitation StateINVITING
target_account_idInvitation Receiver Account ID338c2fc8c29a449dbfa8681f8f1d78e5

7.1.17.2 - 1.1

scpcli organization account invitation list

Description

get account invitation list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
expired_timeInvitation Expired Datetime2024-04-30T12:34:56.789Z
master_account_emailMaster Account Emailadmin@example.com
master_account_idMaster Account Name9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_login_idLogin IDlog-archive@samsung.com
master_account_nameMaster Account NameCoreKim
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
organization_nameOrganization NameMy Organization
requested_timeInvitation Request Datetime2024-04-17T12:34:56.789Z
stateInvitation StateINVITING
target_account_idInvitation Receiver Account ID338c2fc8c29a449dbfa8681f8f1d78e5

7.1.17.3 - 1.0

scpcli organization account invitation list

Description

get account invitation list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
expired_timeInvitation Expired Datetime2024-04-30T12:34:56.789Z
master_account_emailMaster Account Emailadmin@example.com
master_account_idMaster Account Name9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_login_idLogin IDlog-archive@samsung.com
master_account_nameMaster Account NameCoreKim
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
organization_nameOrganization NameMy Organization
requested_timeInvitation Request Datetime2024-04-17T12:34:56.789Z
stateInvitation StateINVITING
target_account_idInvitation Receiver Account ID338c2fc8c29a449dbfa8681f8f1d78e5

7.1.18 - ListAccounts

7.1.18.1 - 1.2

scpcli organization account list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--email <value>]
[--login_id <value>]
[--joined_start_date <value>]
[--joined_end_date <value>]
[--joined_method <value>]
[--exclude_policy_id <value>]
[--parent_unit_id <value>]
[--parent_unit_name <value>]
[--type <value>]

Description

get accounts list

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
name
optional
stringAccount Namescore-account
email
optional
stringAccount Emailscore@samsung.com
login_id
optional
stringLogin IDlog-archive@samsung.com
joined_start_date
optional
stringJoined Start Datetime2024-05-17T12:34:56.789Z
joined_end_date
optional
stringJoined End Datetime2024-05-17T12:34:56.789Z
joined_method
optional
****Joined MethodINVITED
exclude_policy_id
optional
stringPolicy ID to Exclude238c2fc8c29a449dbfa8681f8f1d78e2
parent_unit_id
optional
stringRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_name
optional
stringRoot or Parent Organization Unit Nameparent-unit-name
type
optional
****Account TypeMEMBER

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
emailAccount Emailscore@samsung.com
joined_methodJoined MethodINVITED
joined_timeJoined Datetime2024-05-17T12:34:56.789Z
login_idLogin IDlog-archive@samsung.com
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameAccount Namescore-account
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_idRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_nameRoot or Parent Organization Unit Nameparent-unit-name
stateAccount StatusACTIVE
typeAccount TypeMEMBER

7.1.18.2 - 1.1

scpcli organization account list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--email <value>]
[--login_id <value>]
[--joined_start_date <value>]
[--joined_end_date <value>]
[--joined_method <value>]
[--exclude_policy_id <value>]
[--parent_unit_id <value>]
[--parent_unit_name <value>]
[--type <value>]

Description

get accounts list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
name
optional
stringAccount Namescore-account
email
optional
stringAccount Emailscore@samsung.com
login_id
optional
stringLogin IDlog-archive@samsung.com
joined_start_date
optional
stringJoined Start Datetime2024-05-17T12:34:56.789Z
joined_end_date
optional
stringJoined End Datetime2024-05-17T12:34:56.789Z
joined_method
optional
****Joined MethodINVITED
exclude_policy_id
optional
stringPolicy ID to Exclude238c2fc8c29a449dbfa8681f8f1d78e2
parent_unit_id
optional
stringRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_name
optional
stringRoot or Parent Organization Unit Nameparent-unit-name
type
optional
****Account TypeMEMBER

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
emailAccount Emailscore@samsung.com
joined_methodJoined MethodINVITED
joined_timeJoined Datetime2024-05-17T12:34:56.789Z
login_idLogin IDlog-archive@samsung.com
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameAccount Namescore-account
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_idRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_nameRoot or Parent Organization Unit Nameparent-unit-name
stateAccount StatusACTIVE
typeAccount TypeMEMBER

7.1.18.3 - 1.0

scpcli organization account list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--email <value>]
[--login_id <value>]
[--joined_start_date <value>]
[--joined_end_date <value>]
[--joined_method <value>]
[--exclude_policy_id <value>]
[--parent_unit_id <value>]
[--parent_unit_name <value>]
[--type <value>]

Description

get accounts list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
name
optional
stringAccount Namescore-account
email
optional
stringAccount Emailscore@samsung.com
login_id
optional
stringLogin IDlog-archive@samsung.com
joined_start_date
optional
stringJoined Start Datetime2024-05-17T12:34:56.789Z
joined_end_date
optional
stringJoined End Datetime2024-05-17T12:34:56.789Z
joined_method
optional
****Joined MethodINVITED
exclude_policy_id
optional
stringPolicy ID to Exclude238c2fc8c29a449dbfa8681f8f1d78e2
parent_unit_id
optional
stringRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_name
optional
stringRoot or Parent Organization Unit Nameparent-unit-name
type
optional
****Account TypeMEMBER

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
emailAccount Emailscore@samsung.com
joined_methodJoined MethodINVITED
joined_timeJoined Datetime2024-05-17T12:34:56.789Z
login_idLogin IDlog-archive@samsung.com
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameAccount Namescore-account
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_idRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_nameRoot or Parent Organization Unit Nameparent-unit-name
stateAccount StatusACTIVE
typeAccount TypeMEMBER

7.1.19 - ListOrganizationInvitations

7.1.19.1 - 1.2

scpcli organization organization invitation list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--account_id <value>]
[--account_name <value>]
[--account_email <value>]
[--state <value>]
[--login_id <value>]

Description

get organization invitation list

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
account_id
optional
stringMaster Account Name9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
account_name
optional
stringMaster Account NameCoreKim
account_email
optional
stringMaster Account Emailadmin@example.com
state
optional
****Invitation StateINVITING
login_id
optional
stringLogin IDlog-archive@samsung.com

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
account_emailMaster Account Emailadmin@example.com
account_nameMaster Account NameCoreKim
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
login_idLogin IDlog-archive@samsung.com
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stateInvitation StateINVITING
target_account_idMaster Account Name9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r

7.1.19.2 - 1.1

scpcli organization organization invitation list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--account_id <value>]
[--account_name <value>]
[--account_email <value>]
[--state <value>]
[--login_id <value>]

Description

get organization invitation list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
account_id
optional
stringMaster Account Name9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
account_name
optional
stringMaster Account NameCoreKim
account_email
optional
stringMaster Account Emailadmin@example.com
state
optional
****Invitation StateINVITING
login_id
optional
stringLogin IDlog-archive@samsung.com

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
account_emailMaster Account Emailadmin@example.com
account_nameMaster Account NameCoreKim
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
login_idLogin IDlog-archive@samsung.com
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stateInvitation StateINVITING
target_account_idMaster Account Name9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r

7.1.19.3 - 1.0

scpcli organization organization invitation list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--account_id <value>]
[--account_name <value>]
[--account_email <value>]
[--state <value>]
[--login_id <value>]

Description

get organization invitation list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
account_id
optional
stringMaster Account Name9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
account_name
optional
stringMaster Account NameCoreKim
account_email
optional
stringMaster Account Emailadmin@example.com
state
optional
****Invitation StateINVITING
login_id
optional
stringLogin IDlog-archive@samsung.com

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
account_emailMaster Account Emailadmin@example.com
account_nameMaster Account NameCoreKim
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
login_idLogin IDlog-archive@samsung.com
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stateInvitation StateINVITING
target_account_idMaster Account Name9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r

7.1.20 - ListOrganizations

7.1.20.1 - 1.2

scpcli organization organization list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--master_account_id <value>]

Description

get organizations list

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringOrganization NameMy Organization
master_account_id
optional
stringOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0

Responses

NameDescriptionExample
idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
delegation_account_idDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_idMaster Account ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameOrganization NameMy Organization
root_unit_idRoot Unit IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
use_scp_ynControl Policy Usage YNTrue

7.1.20.2 - 1.1

scpcli organization organization list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--master_account_id <value>]

Description

get organizations list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringOrganization NameMy Organization
master_account_id
optional
stringOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0

Responses

NameDescriptionExample
idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
delegation_account_idDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_idMaster Account ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameOrganization NameMy Organization
root_unit_idRoot Unit IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
use_scp_ynControl Policy Usage YNTrue

7.1.20.3 - 1.0

scpcli organization organization list
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--master_account_id <value>]

Description

get organizations list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringOrganization NameMy Organization
master_account_id
optional
stringOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0

Responses

NameDescriptionExample
idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
delegation_account_idDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_idMaster Account ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
nameOrganization NameMy Organization
root_unit_idRoot Unit IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
use_scp_ynControl Policy Usage YNTrue

7.1.21 - ListOrganizationUnits

7.1.21.1 - 1.2

scpcli organization organization unit list
--parent_unit_id <value>
[--organization_id <value>]
[--name <value>]
[--exclude_policy_id <value>]

Description

get organization unit list

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
parent_unit_id
required
stringRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
optional
stringOrganization Unit Namescore-organization-unit
exclude_policy_id
optional
stringPolicy ID to Exclude238c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idOrganization Unit ID or Organization Account IDou-c29a138f8f1d78e24dbfa8681fc2fc8
created_atCreated At2025-01-01T00:00:00.000Z
depthHierarchy (0~5)1
emailAccount Emailscore@samsung.com
joined_methodJoined MethodINVITED
joined_timeJoined Datetime2024-05-17T12:34:56.789Z
login_idLogin IDlog-archive@samsung.com
nameOrganization Unit Name or Account Namescore-organization-unit
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_idRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_nameRoot or Parent Organization Unit Nameparent-unit-name
typeType (Root or Organization Unit) or Account TypeMEMBER

7.1.21.2 - 1.1

scpcli organization organization unit list
--parent_unit_id <value>
[--organization_id <value>]
[--name <value>]
[--exclude_policy_id <value>]

Description

get organization unit list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
parent_unit_id
required
stringRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
optional
stringOrganization Unit Namescore-organization-unit
exclude_policy_id
optional
stringPolicy ID to Exclude238c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idOrganization Unit ID or Organization Account IDou-c29a138f8f1d78e24dbfa8681fc2fc8
created_atCreated At2025-01-01T00:00:00.000Z
depthHierarchy (0~5)1
emailAccount Emailscore@samsung.com
joined_methodJoined MethodINVITED
joined_timeJoined Datetime2024-05-17T12:34:56.789Z
login_idLogin IDlog-archive@samsung.com
nameOrganization Unit Name or Account Namescore-organization-unit
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_idRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
parent_unit_nameRoot or Parent Organization Unit Nameparent-unit-name
typeType (Root or Organization Unit) or Account TypeMEMBER

7.1.21.3 - 1.0

scpcli organization organization unit list
--parent_unit_id <value>
[--organization_id <value>]
[--name <value>]
[--exclude_policy_id <value>]

Description

get organization unit list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
parent_unit_id
required
stringRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
name
optional
stringOrganization Unit Namescore-organization-unit
exclude_policy_id
optional
stringPolicy ID to Exclude238c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idOrganization Unit ID or Organization Account IDou-c29a138f8f1d78e24dbfa8681fc2fc8
created_atCreated At2025-01-01T00:00:00.000Z
depthHierarchy (0~5)1
emailAccount Emailscore@samsung.com
joined_methodJoined MethodINVITED
joined_timeJoined Datetime2024-05-17T12:34:56.789Z
login_idLogin IDlog-archive@samsung.com
nameOrganization Unit Name or Account Namescore-organization-unit
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
parent_unit_idRoot or Parent Organization Unit IDou-fc8c29a138d78e24bf1fa86812fc8b
typeType (Root or Organization Unit) or Account TypeMEMBER

7.1.22 - ListParents

7.1.22.1 - 1.2

scpcli organization organization unit parent list
--unit_id <value>
[--organization_id <value>]

Description

get organization unit parent list

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
unit_id
required
stringOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
idOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
depthHierarchy (0~5)1
descriptionOrganization Unit DescriptionScore Organization Unit
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameOrganization Unit Namescore-organization-unit
parent_unit_idType (Root or Organization Unit)ou-fc8c29a138d78e24bf1fa86812fc8b
service_nameService NameOrganization
srnOrganization Unit SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8
typeType (Root or Organization Unit)OU

7.1.22.2 - 1.1

scpcli organization organization unit parent list
--unit_id <value>
[--organization_id <value>]

Description

get organization unit parent list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
unit_id
required
stringOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
idOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
depthHierarchy (0~5)1
descriptionOrganization Unit DescriptionScore Organization Unit
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameOrganization Unit Namescore-organization-unit
parent_unit_idType (Root or Organization Unit)ou-fc8c29a138d78e24bf1fa86812fc8b
service_nameService NameOrganization
srnOrganization Unit SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8
typeType (Root or Organization Unit)OU

7.1.22.3 - 1.0

scpcli organization organization unit parent list
--unit_id <value>
[--organization_id <value>]

Description

get organization unit parent list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
unit_id
required
stringOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
idOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
depthHierarchy (0~5)1
descriptionOrganization Unit DescriptionScore Organization Unit
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameOrganization Unit Namescore-organization-unit
parent_unit_idType (Root or Organization Unit)ou-fc8c29a138d78e24bf1fa86812fc8b
service_nameService NameOrganization
srnOrganization Unit SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8
typeType (Root or Organization Unit)OU

7.1.23 - ListPoliciesForTarget

7.1.23.1 - 1.2

scpcli organization target policy list
--target_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]

Description

list policies for target

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
target_id
required
stringTarget IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_category
optional
****Policy CategorySCP
name
optional
stringControl Policy Nametest-policy-name

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
link_typesLink Type{‘DIRECTED’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’, ’target_type’: ‘OU’}], ‘INHERITED’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’, ’target_type’: ‘ROOT’}]}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
policy_nameControl Policy Nametest-policy-name
policy_typeControl Policy TypeSYSTEM_MANAGED
sourcePolicy Creation SubjectORGANIZATION

7.1.23.2 - 1.1

scpcli organization target policy list
--target_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]

Description

list policies for target

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
target_id
required
stringTarget IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_category
optional
****Policy CategorySCP
name
optional
stringControl Policy Nametest-policy-name

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
link_typesLink Type{‘DIRECTED’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’, ’target_type’: ‘OU’}], ‘INHERITED’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’, ’target_type’: ‘ROOT’}]}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
policy_nameControl Policy Nametest-policy-name
policy_typeControl Policy TypeSYSTEM_MANAGED
sourcePolicy Creation SubjectORGANIZATION

7.1.23.3 - 1.0

scpcli organization target policy list
--target_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]

Description

list policies for target

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
target_id
required
stringTarget IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_category
optional
****Policy CategorySCP
name
optional
stringControl Policy Nametest-policy-name

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
link_typesLink Type{‘DIRECTED’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’, ’target_type’: ‘OU’}], ‘INHERITED’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’, ’target_type’: ‘ROOT’}]}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
policy_nameControl Policy Nametest-policy-name
policy_typeControl Policy TypeSYSTEM_MANAGED
sourcePolicy Creation SubjectORGANIZATION

7.1.24 - ListServiceControlPolicies

7.1.24.1 - 1.2

scpcli organization service control policy list
--organization_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--exclude_target_id <value>]

Description

get service control policies list

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
name
optional
arrayService Control Policy NameM
type
optional
****Service Control Policy TypeMANAGED
exclude_target_id
optional
stringTarget ID to Exclude112c2fc8c29a449dbfa8681f8f1d7442

Responses

NameDescriptionExample
idService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
categoryPolicy CategorySCP
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
descriptionPolicy DescriptionThis is an example policy.
documentPolicy Document{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameService Control Policy NameMyPolicy
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
sourcePolicy Creation SubjectORGANIZATION
statePolicy StateACTIVE
typeService Control Policy TypeMANAGED

7.1.24.2 - 1.1

scpcli organization service control policy list
--organization_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--exclude_target_id <value>]

Description

get service control policies list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
name
optional
arrayService Control Policy NameM
type
optional
****Service Control Policy TypeMANAGED
exclude_target_id
optional
stringTarget ID to Exclude112c2fc8c29a449dbfa8681f8f1d7442

Responses

NameDescriptionExample
idService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
categoryPolicy CategorySCP
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
descriptionPolicy DescriptionThis is an example policy.
documentPolicy Document{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameService Control Policy NameMyPolicy
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
sourcePolicy Creation SubjectORGANIZATION
statePolicy StateACTIVE
typeService Control Policy TypeMANAGED

7.1.24.3 - 1.0

scpcli organization service control policy list
--organization_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--exclude_target_id <value>]

Description

get service control policies list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
name
optional
arrayService Control Policy NameM
type
optional
****Service Control Policy TypeMANAGED
exclude_target_id
optional
stringTarget ID to Exclude112c2fc8c29a449dbfa8681f8f1d7442

Responses

NameDescriptionExample
idService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
categoryPolicy CategorySCP
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
descriptionPolicy DescriptionThis is an example policy.
documentPolicy Document{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameService Control Policy NameMyPolicy
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
sourcePolicy Creation SubjectORGANIZATION
statePolicy StateACTIVE
typeService Control Policy TypeMANAGED

7.1.25 - ListTargetsForPolicy

7.1.25.1 - 1.2

scpcli organization policy target list
--target_type <value>
--policy_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]

Description

list targets for policy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
target_type
required
****Target TypeOU
policy_id
required
stringControl Policy IDf98e76d54c32b10a9z8y7x6w5v4u3
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_category
optional
****Policy CategorySCP
name
optional
stringTarget Nameexample-target

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
control_policiesControl Policy ID List
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
target_nameTarget Nameexample-target

7.1.25.2 - 1.1

scpcli organization policy target list
--target_type <value>
--policy_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]

Description

list targets for policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
target_type
required
****Target TypeOU
policy_id
required
stringControl Policy IDf98e76d54c32b10a9z8y7x6w5v4u3
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_category
optional
****Policy CategorySCP
name
optional
stringTarget Nameexample-target

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
control_policiesControl Policy ID List
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
target_nameTarget Nameexample-target

7.1.25.3 - 1.0

scpcli organization policy target list
--target_type <value>
--policy_id <value>
[--organization_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--policy_category <value>]
[--name <value>]

Description

list targets for policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
target_type
required
****Target TypeOU
policy_id
required
stringControl Policy IDf98e76d54c32b10a9z8y7x6w5v4u3
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
policy_category
optional
****Policy CategorySCP
name
optional
stringTarget Nameexample-target

Responses

NameDescriptionExample
idID0a36e0746dbf4908acf0357829701381
control_policiesControl Policy ID List
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
target_nameTarget Nameexample-target

7.1.26 - MoveAccount

7.1.26.1 - 1.2

scpcli organization account move
--target_account_ids <value>
--parent_unit_id <value>
[--organization_id <value>]

Description

move a specific account to a different OU

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
target_account_ids
required
arrayTarget Account ID Listb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
parent_unit_id
required
stringRoot ID or Organization Unit IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.26.2 - 1.1

scpcli organization account move
--target_account_ids <value>
--parent_unit_id <value>
[--organization_id <value>]

Description

move a specific account to a different OU

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
target_account_ids
required
arrayTarget Account ID Listb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
parent_unit_id
required
stringRoot ID or Organization Unit IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.26.3 - 1.0

scpcli organization account move
--target_account_ids <value>
--parent_unit_id <value>
[--organization_id <value>]

Description

move a specific account to a different OU

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
target_account_ids
required
arrayTarget Account ID Listb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
parent_unit_id
required
stringRoot ID or Organization Unit IDou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.27 - RemoveAccounts

7.1.27.1 - 1.2

scpcli organization account remove
--target_account_ids <value>
[--organization_id <value>]

Description

Remove accounts from organization

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
target_account_ids
required
arrayTarget Account ID Listb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.27.2 - 1.1

scpcli organization account remove
--target_account_ids <value>
[--organization_id <value>]

Description

Remove accounts from organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
target_account_ids
required
arrayTarget Account ID Listb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.27.3 - 1.0

scpcli organization account remove
--target_account_ids <value>
[--organization_id <value>]

Description

Remove accounts from organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
target_account_ids
required
arrayTarget Account ID Listb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.28 - RemovePolicyBindings

7.1.28.1 - 1.2

scpcli organization policy remove
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]

Description

remove policy bindings

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
target_ids
required
arrayTarget Infoou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
policy_ids
required
arrayControl Policy List IDf98e76d54c32b10a9z8y7x6w5v4u3
entity
required
stringEntity TypePOLICY
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.28.2 - 1.1

scpcli organization policy remove
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]

Description

remove policy bindings

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
target_ids
required
arrayTarget Infoou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
policy_ids
required
arrayControl Policy List IDf98e76d54c32b10a9z8y7x6w5v4u3
entity
required
stringEntity TypePOLICY
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.28.3 - 1.0

scpcli organization policy remove
--target_ids <value>
--policy_ids <value>
--entity <value>
[--organization_id <value>]

Description

remove policy bindings

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
target_ids
required
arrayTarget Infoou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
policy_ids
required
arrayControl Policy List IDf98e76d54c32b10a9z8y7x6w5v4u3
entity
required
stringEntity TypePOLICY
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.29 - SetDelegationPolicy

7.1.29.1 - 1.2

scpcli organization delegation policy set
[--organization_id <value>]
[--statement <value>]
[--version <value>]

Description

set a specific delegation policy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

7.1.29.2 - 1.1

scpcli organization delegation policy set
[--organization_id <value>]
[--statement <value>]
[--version <value>]

Description

set a specific delegation policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

7.1.29.3 - 1.0

scpcli organization delegation policy set
[--organization_id <value>]
[--statement <value>]
[--version <value>]

Description

set a specific delegation policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

7.1.30 - SetOrganization

7.1.30.1 - 1.2

scpcli organization organization set
--organization_id <value>
[--delegation_account_id <value>]
[--name <value>]
[--organization_id <value>]
[--use_scp_yn <value>]

Description

set a specific organization

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
delegation_account_id
optional
stringDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
name
optional
stringOrganization NameMy Organization
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_yn
optional
booleanControl Policy Usage YNTrue

7.1.30.2 - 1.1

scpcli organization organization set
--organization_id <value>
[--delegation_account_id <value>]
[--name <value>]
[--organization_id <value>]
[--use_scp_yn <value>]

Description

set a specific organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
delegation_account_id
optional
stringDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
name
optional
stringOrganization NameMy Organization
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_yn
optional
booleanControl Policy Usage YNTrue

7.1.30.3 - 1.0

scpcli organization organization set
--organization_id <value>
[--delegation_account_id <value>]
[--name <value>]
[--organization_id <value>]
[--use_scp_yn <value>]

Description

set a specific organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
delegation_account_id
optional
stringDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
name
optional
stringOrganization NameMy Organization
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_yn
optional
booleanControl Policy Usage YNTrue

7.1.31 - SetOrganizationUnit

7.1.31.1 - 1.2

scpcli organization organization unit set
--unit_id <value>
[--description <value>]
[--name <value>]
[--organization_id <value>]

Description

set a specific organization unit

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
unit_id
required
stringOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
description
optional
stringOrganization Unit DescriptionScore Organization Unit
name
optional
stringOrganization Unit Namescore-organization-unit
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.31.2 - 1.1

scpcli organization organization unit set
--unit_id <value>
[--description <value>]
[--name <value>]
[--organization_id <value>]

Description

set a specific organization unit

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
unit_id
required
stringOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
description
optional
stringOrganization Unit DescriptionScore Organization Unit
name
optional
stringOrganization Unit Namescore-organization-unit
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.31.3 - 1.0

scpcli organization organization unit set
--unit_id <value>
[--description <value>]
[--name <value>]
[--organization_id <value>]

Description

set a specific organization unit

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
unit_id
required
stringOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
description
optional
stringOrganization Unit DescriptionScore Organization Unit
name
optional
stringOrganization Unit Namescore-organization-unit
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.32 - SetServiceControlPolicy

7.1.32.1 - 1.2

scpcli organization service control policy set
--policy_id <value>
--organization_id <value>
[--description <value>]
[--name <value>]
[--statement <value>]
[--version <value>]

Description

set a specific service control policy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
description
optional
stringPolicy DescriptionThis is an example policy.
name
optional
stringService Control Policy NameMyPolicy
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

7.1.32.2 - 1.1

scpcli organization service control policy set
--policy_id <value>
--organization_id <value>
[--description <value>]
[--name <value>]
[--statement <value>]
[--version <value>]

Description

set a specific service control policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
description
optional
stringPolicy DescriptionThis is an example policy.
name
optional
stringService Control Policy NameMyPolicy
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

7.1.32.3 - 1.0

scpcli organization service control policy set
--policy_id <value>
--organization_id <value>
[--description <value>]
[--name <value>]
[--statement <value>]
[--version <value>]

Description

set a specific service control policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
policy_id
required
stringService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
description
optional
stringPolicy DescriptionThis is an example policy.
name
optional
stringService Control Policy NameMyPolicy
statement
optional
arrayPolicy Syntax'{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}'
version
optional
stringPolicy Version-

7.1.33 - ShowAccount

7.1.33.1 - 1.2

scpcli organization account show
--account_id <value>
[--organization_id <value>]
[--lazy_policy <value>]

Description

show a specific account

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
account_id
required
stringOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
lazy_policy
optional
booleanLinked Policy Query YNTrue

Responses

NameDescriptionExample
accountOrganization Account Detail Info

7.1.33.2 - 1.1

scpcli organization account show
--account_id <value>
[--organization_id <value>]
[--lazy_policy <value>]

Description

show a specific account

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
account_id
required
stringOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
lazy_policy
optional
booleanLinked Policy Query YNTrue

Responses

NameDescriptionExample
accountOrganization Account Detail Info

7.1.33.3 - 1.0

scpcli organization account show
--account_id <value>
[--organization_id <value>]
[--lazy_policy <value>]

Description

show a specific account

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
account_id
required
stringOrganization Account IDb4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
lazy_policy
optional
booleanLinked Policy Query YNTrue

Responses

NameDescriptionExample
accountOrganization Account Detail Info

7.1.34 - ShowDelegationPolicy

7.1.34.1 - 1.2

scpcli organization delegation policy show
[--organization_id <value>]

Description

show a specific delegation policy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
documentDelegation Policy Document{‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.34.2 - 1.1

scpcli organization delegation policy show
[--organization_id <value>]

Description

show a specific delegation policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
documentDelegation Policy Document{‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.34.3 - 1.0

scpcli organization delegation policy show
[--organization_id <value>]

Description

show a specific delegation policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
documentDelegation Policy Document{‘Statement’: [{‘Action’: [‘organization:CreateServiceControlPolicy’, ‘organization:DeleteServiceControlPolicies’, ‘organization:SetServiceControlPolicy’, ‘organization:ShowServiceControlPolicy’, ‘organization:ListServiceControlPolicies’, ‘organization:ShowAccount’, ‘organization:ListAccounts’, ‘organization:ListOrganizationUnits’, ‘organization:ListOrganizationInvitations’, ‘organization:ListParents’, ‘organization:ListPoliciesForTarget’, ‘organization:ListTargetsForPolicy’, ‘organization:AttachPolicyBindings’, ‘organization:RemovePolicyBindings’, ‘organization:ShowDelegatePolicy’], ‘Effect’: ‘Allow’, ‘Principal’: {‘scp’: [‘srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df’]}, ‘Resource’: [’*’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

7.1.35 - ShowOrganization

7.1.35.1 - 1.2

scpcli organization organization show
--organization_id <value>

Description

show a specific organization

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
delegation_account_idDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_emailMaster Account Emailadmin@example.com
master_account_idMaster Account ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameOrganization NameMy Organization
root_unit_idRoot Unit IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
srnOrganization SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_ynControl Policy Usage YNTrue

7.1.35.2 - 1.1

scpcli organization organization show
--organization_id <value>

Description

show a specific organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
delegation_account_idDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_emailMaster Account Emailadmin@example.com
master_account_idMaster Account ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameOrganization NameMy Organization
root_unit_idRoot Unit IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
srnOrganization SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_ynControl Policy Usage YNTrue

7.1.35.3 - 1.0

scpcli organization organization show
--organization_id <value>

Description

show a specific organization

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
organization_id
required
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
delegation_account_idDelegation Account124e7d6c5b4a3z2y1x0w9v8u7t6s5r
master_account_emailMaster Account Emailadmin@example.com
master_account_idMaster Account ID9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameOrganization NameMy Organization
root_unit_idRoot Unit IDr-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r
srnOrganization SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
use_scp_ynControl Policy Usage YNTrue

7.1.36 - ShowOrganizationUnit

7.1.36.1 - 1.2

scpcli organization organization unit show
--unit_id <value>
[--organization_id <value>]

Description

show a specific organization unit

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
unit_id
required
stringOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
organization_unitOrganization Unit Info

7.1.36.2 - 1.1

scpcli organization organization unit show
--unit_id <value>
[--organization_id <value>]

Description

show a specific organization unit

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
unit_id
required
stringOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
organization_unitOrganization Unit Info

7.1.36.3 - 1.0

scpcli organization organization unit show
--unit_id <value>
[--organization_id <value>]

Description

show a specific organization unit

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
unit_id
required
stringOrganization Unit IDou-c29a138f8f1d78e24dbfa8681fc2fc8
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
organization_unitOrganization Unit Info

7.1.37 - ShowServiceControlPolicy

7.1.37.1 - 1.2

scpcli organization service control policy show
--policy_id <value>
[--organization_id <value>]

Description

show a specific service control policy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
policy_id
required
stringService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
idService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
categoryPolicy CategorySCP
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
descriptionPolicy DescriptionThis is an example policy.
documentPolicy Document{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameService Control Policy NameMyPolicy
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
service_nameService NameOrganization
sourcePolicy Creation SubjectORGANIZATION
srnPolicy SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2
statePolicy StateACTIVE
typeService Control Policy TypeMANAGED

7.1.37.2 - 1.1

scpcli organization service control policy show
--policy_id <value>
[--organization_id <value>]

Description

show a specific service control policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
policy_id
required
stringService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
idService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
categoryPolicy CategorySCP
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
descriptionPolicy DescriptionThis is an example policy.
documentPolicy Document{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameService Control Policy NameMyPolicy
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
service_nameService NameOrganization
sourcePolicy Creation SubjectORGANIZATION
srnPolicy SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2
statePolicy StateACTIVE
typeService Control Policy TypeMANAGED

7.1.37.3 - 1.0

scpcli organization service control policy show
--policy_id <value>
[--organization_id <value>]

Description

show a specific service control policy

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
policy_id
required
stringService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
organization_id
optional
stringOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5

Responses

NameDescriptionExample
idService Control Policy ID138c2fc8c29a449dbfa8681f8f1d78e2
categoryPolicy CategorySCP
created_atCreated At2025-01-01T00:00:00.000Z
created_byCreated Byc23fb561c689455993874fa5d5ed4a2f
creator_nameCreator NameJohn Doe na
descriptionPolicy DescriptionThis is an example policy.
documentPolicy Document{‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’}
modified_atModified At2025-01-01T00:00:00.000Z
modified_byModified Byc23fb561c689455993874fa5d5ed4a2f
modifier_nameModifier NameAlice
nameService Control Policy NameMyPolicy
organization_idOrganization IDo-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
service_nameService NameOrganization
sourcePolicy Creation SubjectORGANIZATION
srnPolicy SRNsrn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2
statePolicy StateACTIVE
typeService Control Policy TypeMANAGED

8 - Quota Service

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Quota service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.3CURRENT-
1.2DEPRECATED20260223
1.1DEPRECATED20260223
1.0DEPRECATED20260223

8.1 - CLIs

8.1.1 - ListAccountQuota

8.1.1.1 - 1.3

scpcli quota account-quota list
[--size <value>]
[--page <value>]
[--sort <value>]
[--request_class <value>]
[--service <value>]
[--quota_item <value>]
[--description <value>]

Description

get account quota list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
request_class
optional
stringRequest ClassAccount
service
optional
stringService NameIAM
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
description
optional
stringDescriptionVirtual Server disk max size

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
max_per_accountMax per Account Value1000
modified_atModified At2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

8.1.1.2 - 1.2

scpcli quota account-quota list
[--size <value>]
[--page <value>]
[--sort <value>]
[--request_class <value>]
[--service <value>]
[--quota_item <value>]
[--description <value>]

Description

get account quota list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
request_class
optional
stringRequest ClassAccount
service
optional
stringService NameIAM
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
description
optional
stringDescriptionVirtual Server disk max size

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
max_per_accountMax per Account Value1000
modified_atModified At2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

8.1.1.3 - 1.1

scpcli quota account-quota list
[--size <value>]
[--page <value>]
[--sort <value>]
[--request_class <value>]
[--service <value>]
[--quota_item <value>]
[--description <value>]

Description

get account quota list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
request_class
optional
stringRequest ClassAccount
service
optional
stringService NameIAM
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
description
optional
stringDescriptionVirtual Server disk max size

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
max_per_accountMax per Account Value1000
modified_atModified At2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

8.1.1.4 - 1.0

scpcli quota account-quota list
[--size <value>]
[--page <value>]
[--sort <value>]
[--request_class <value>]
[--service <value>]
[--quota_item <value>]
[--description <value>]

Description

get account quota list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
request_class
optional
stringRequest ClassAccount
service
optional
stringService NameIAM
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
description
optional
stringDescriptionVirtual Server disk max size

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
modified_atModified At2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

8.1.2 - ListQuotaRequests

8.1.2.1 - 1.3

scpcli quota quota-request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--service <value>]
[--quota_item <value>]
[--requester <value>]
[--request_class <value>]
[--requested_start_at <value>]
[--requested_end_at <value>]
[--applied_start_at <value>]
[--applied_end_at <value>]
[--state <value>]

Description

get quota requests list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
service
optional
stringService NameVirtual Server
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
requester
optional
stringRequester Informationcloud.kim
request_class
optional
stringRequest ClassAccount
requested_start_at
optional
stringStart date of the request2024-05-01
requested_end_at
optional
stringEnd date of the request2024-05-31
applied_start_at
optional
stringStart date of the application2024-05-01
applied_end_at
optional
stringEnd date of the application2024-05-31
state
optional
stringRequest StateBEFORE_APPROVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
request_classRequest ClassAccount
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
serviceService NameVirtual Server
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

8.1.2.2 - 1.2

scpcli quota quota-request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--service <value>]
[--quota_item <value>]
[--requester <value>]
[--request_class <value>]
[--requested_start_at <value>]
[--requested_end_at <value>]
[--applied_start_at <value>]
[--applied_end_at <value>]
[--state <value>]

Description

get quota requests list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
service
optional
stringService NameVirtual Server
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
requester
optional
stringRequester Informationcloud.kim
request_class
optional
stringRequest ClassAccount
requested_start_at
optional
stringStart date of the request2024-05-01
requested_end_at
optional
stringEnd date of the request2024-05-31
applied_start_at
optional
stringStart date of the application2024-05-01
applied_end_at
optional
stringEnd date of the application2024-05-31
state
optional
stringRequest StateBEFORE_APPROVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
request_classRequest ClassAccount
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
serviceService NameVirtual Server
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

8.1.2.3 - 1.1

scpcli quota quota-request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--service <value>]
[--quota_item <value>]
[--requester <value>]
[--request_class <value>]
[--requested_start_at <value>]
[--requested_end_at <value>]
[--applied_start_at <value>]
[--applied_end_at <value>]
[--state <value>]

Description

get quota requests list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
service
optional
stringService NameVirtual Server
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
requester
optional
stringRequester Informationcloud.kim
request_class
optional
stringRequest ClassAccount
requested_start_at
optional
stringStart date of the request2024-05-01
requested_end_at
optional
stringEnd date of the request2024-05-31
applied_start_at
optional
stringStart date of the application2024-05-01
applied_end_at
optional
stringEnd date of the application2024-05-31
state
optional
stringRequest StateBEFORE_APPROVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
request_classRequest ClassAccount
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
serviceService NameVirtual Server
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

8.1.2.4 - 1.0

scpcli quota quota-request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--service <value>]
[--quota_item <value>]
[--requester <value>]
[--request_class <value>]
[--requested_start_at <value>]
[--requested_end_at <value>]
[--applied_start_at <value>]
[--applied_end_at <value>]
[--state <value>]

Description

get quota requests list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
service
optional
stringService NameVirtual Server
quota_item
optional
stringQuota Item NameQUOTA.REQUEST.COUNT
requester
optional
stringRequester Informationcloud.kim
request_class
optional
stringRequest ClassAccount
requested_start_at
optional
stringStart date of the request2024-05-01
requested_end_at
optional
stringEnd date of the request2024-05-31
applied_start_at
optional
stringStart date of the application2024-05-01
applied_end_at
optional
stringEnd date of the application2024-05-31
state
optional
stringRequest StateBEFORE_APPROVE

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
request_classRequest ClassAccount
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
serviceService NameVirtual Server
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

8.1.3 - ShowAccountQuota

8.1.3.1 - 1.3

scpcli quota account-quota show
--account_quota_id <value>

Description

show a specific account quota

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
account_quota_id
required
stringAccount Quota ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
max_per_accountMax per Account Value1000
modified_atModified At2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

8.1.3.2 - 1.2

scpcli quota account-quota show
--account_quota_id <value>

Description

show a specific account quota

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260223

Parameters

NameTypeDescriptionExample
account_quota_id
required
stringAccount Quota ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
max_per_accountMax per Account Value1000
modified_atModified At2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

8.1.3.3 - 1.1

scpcli quota account-quota show
--account_quota_id <value>

Description

show a specific account quota

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260223

Parameters

NameTypeDescriptionExample
account_quota_id
required
stringAccount Quota ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
max_per_accountMax per Account Value1000
modified_atModified At2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

8.1.3.4 - 1.0

scpcli quota account-quota show
--account_quota_id <value>

Description

show a specific account quota

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
account_quota_id
required
stringAccount Quota ID138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idUnique identifier for the account2b7ed60576ce404bbc734266ff1839a5
account_nameName of the accountExample Account
adjustableFlag indicating if additional quota is being requestedTrue
applied_valueModified quota value after changes200
approvalApprovalFalse
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial quota value allocated100
modified_atModified At2024-05-17T00:23:17Z
quota_itemSpecific quota item within the resourceQUOTA.REQUEST.COUNT
reductionReductionFalse
requestRequestFalse
request_classRequest ClassAccount
resource_typeType of the resourceaccount-quota
serviceName of the service to which quota appliesVirtual Server
srnService Resource Name for the quota itemsrn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678
unitUnit in which the quota value is measuredGB

8.1.4 - ShowQuotaRequest

8.1.4.1 - 1.3

scpcli quota quota-request show
--request_id <value>

Description

show a specific quota request

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID0c2a06f2f06d42248a6bb88b1a78d4cc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_quota_idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
reductionReductionFalse
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

8.1.4.2 - 1.2

scpcli quota quota-request show
--request_id <value>

Description

show a specific quota request

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.220260223

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID0c2a06f2f06d42248a6bb88b1a78d4cc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_quota_idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
reductionReductionFalse
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

8.1.4.3 - 1.1

scpcli quota quota-request show
--request_id <value>

Description

show a specific quota request

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260223

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID0c2a06f2f06d42248a6bb88b1a78d4cc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_quota_idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
reductionReductionFalse
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

8.1.4.4 - 1.0

scpcli quota quota-request show
--request_id <value>

Description

show a specific quota request

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

NameTypeDescriptionExample
request_id
required
stringRequest ID0c2a06f2f06d42248a6bb88b1a78d4cc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_quota_idAccount Quota ID0fdd87aab8cb46f59b7c1f81ed03fb3e
applied_atApplied At2024-05-17T00:23:17Z
applied_valueApplied Value200
approval_messageRequest messageQuota increase request message.
class_valueValue associated with the request classGlobal
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDetailed description of the quota itemMaximum disk size for virtual servers in the account
free_rateFree Rate10
initial_valueInitial Value100
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
quota_itemQuota Item NameQUOTA.REQUEST.COUNT
reductionReductionFalse
request_messageRequest messageQuota increase request message.
request_valueUser Request Value300
requesterRequestercloudkim
stateRequest StateBEFORE_APPROVE
unitUnit in which the quota value is measuredGB

9 - Resource Manager

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Resourcemanager service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.0CURRENT-

9.1 - CLIs

9.1.1 - CreateResourceGroup

9.1.1.1 - 1.0

scpcli resourcemanager resource group create
--name <value>
--description <value>
[--region <value>]
[--resource_types <value>]
[--tags <value>]

Description

create a resource_group

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
name
required
stringResource Group nameresource-group-1
description
required
stringResource Group descriptionresource group 1
region
optional
stringRegionkr-west1
resource_types
optional
arrayResource type list (service:resource_type)[
tags
optional
arrayTag list'{"key": "tag-key", "value": "tag-value"}'

Responses

NameDescriptionExample
resource_groupResource Group

9.1.2 - DeleteComponentsTag

9.1.2.1 - 1.0

scpcli resourcemanager components tag key delete
--key <value>
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>

Description

delete a specific components tag

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
key
required
stringTag key (base64 encoded KEY)dGFnLWtleQ==
resource_identifier
required
stringResource IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
stringResource typevirtual-server
service
required
stringService namevirtualserver
region
required
stringRegionkr-west1

9.1.3 - DeleteComponentsTags

9.1.3.1 - 1.0

scpcli resourcemanager components tag delete
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>

Description

delete components tags

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
resource_identifier
required
stringResource IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
stringResource typevirtual-server
service
required
stringService namevirtualserver
region
required
stringRegionkr-west1

9.1.4 - DeleteResourceGroup

9.1.4.1 - 1.0

scpcli resourcemanager resource group delete
--resource_group_id <value>

Description

delete a specific resource_group

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
resource_group_id
required
stringResource Group ID1486t61d84b354fb9135cc467owe1346

9.1.5 - DeleteResourceGroups

9.1.5.1 - 1.0

scpcli resourcemanager resource group delete bulk
[--ids <value>]

Description

delete a specific resource_groups

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
ids
optional
arrayResource Group ID list[

9.1.6 - DeleteResourceTag

9.1.6.1 - 1.0

scpcli resourcemanager resource tag key delete
--key <value>
--srn <value>

Description

delete a specific resource tag

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
key
required
stringTag key (base64 encoded KEY)dGFnLWtleQ==
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==

9.1.7 - DeleteResourceTags

9.1.7.1 - 1.0

scpcli resourcemanager resource tag delete
--srn <value>

Description

delete resource tags

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==

9.1.8 - DeleteTags

9.1.8.1 - 1.0

scpcli resourcemanager tag delete
--tags <value>

Description

delete tags

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
tags
required
dictTag key list{"srn:e::PROJECT-NTcEraJPrRhNGqldsJLTnf:kr-east1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m": ["key1", "key4"]}

9.1.9 - ListComponentsTags

9.1.9.1 - 1.0

scpcli resourcemanager components tag list
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--key <value>]
[--value <value>]

Description

get components tags

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
resource_identifier
required
stringResource IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
stringResource typevirtual-server
service
required
stringService namevirtualserver
region
required
stringRegionkr-west1
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
key
optional
stringTag keytag-key
value
optional
stringTag valuetag-value

Responses

NameDescriptionExample
contentTag list
countcount20
pagepage0
sizesize20
sortsort[‘created_at:asc’]

9.1.10 - ListResourceGroupResources

9.1.10.1 - 1.0

scpcli resourcemanager resource group resource list
--resource_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

list a specific resource_group_resources

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
resource_group_id
required
stringResource Group ID1486t61d84b354fb9135cc467owe1346
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID1234ab567cd64769e8f9g490hi304891
created_atCreated At2025-02-27T10:23:43Z
created_byCreated By7123ke8439734e5789lj355b17ef5473
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
product_nameProduct/ServiceVirtual Server
regionRegionkr-west1
resource_nameResource nameresource-name-1
resource_typeResource typevirtual-server
resource_type_display_nameResource type nameVirtual Server
serviceServicevirtualserver
service_nameService nameVirtual Server
srnSRNsrn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496
stateStateSuccess
tagsTag list[{“key1”: “value1”}, {“key2”: “value2”}]

9.1.11 - ListResourceGroups

9.1.11.1 - 1.0

scpcli resourcemanager resource group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--region <value>]

Description

get resource_groups list

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringResource Group ID1486t61d84b354fb9135cc467owe1346
name
optional
stringResource Group nameresource-group-1
region
optional
stringRegionkr-west1

Responses

NameDescriptionExample
idResource Group ID1486t61d84b354fb9135cc467owe1346
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionResource Group descriptionresource group 1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameResource Group nameresource-group-1
regionRegionkr-west1
resource_typesResource type list[“resourcemanager:resource-group”, “loggingaudit:trail”]
tagsTag list[{“key”: “key1”, “value”: “value1”}, {“key”: “key2”, “value”: “value2”}]

9.1.12 - ListResources

9.1.12.1 - 1.0

scpcli resourcemanager resource list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--resource_name <value>]
[--service_name <value>]
[--resource_type <value>]
[--region <value>]

Description

get resources list

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringResource IDz95fa561-11u3-4frw-962g-3b123123c496
resource_name
optional
stringResource nameresource-name-1
service_name
optional
stringService nameVirtual Server
resource_type
optional
stringResource typevirtual-server
region
optional
stringRegionkr-west1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID1234ab567cd64769e8f9g490hi304891
created_atCreated At2025-02-27T10:23:43Z
created_byCreated By7123ke8439734e5789lj355b17ef5473
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
product_nameProduct/ServiceVirtual Server
regionRegionkr-west1
resource_nameResource nameresource-name-1
resource_typeResource typevirtual-server
resource_type_display_nameResource type nameVirtual Server
serviceServicevirtualserver
service_nameService nameVirtual Server
srnSRNsrn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496
stateStateSuccess
tagsTag list[{“key1”: “value1”}, {“key2”: “value2”}]

9.1.13 - ListResourceTags

9.1.13.1 - 1.0

scpcli resourcemanager resource tag list
--srn <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--key <value>]
[--value <value>]

Description

get resource tags

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
key
optional
stringTag keytag-key
value
optional
stringTag valuetag-value

Responses

NameDescriptionExample
contentTag list
countcount20
pagepage0
sizesize20
sortsort[‘created_at:asc’]

9.1.14 - ListTagKeys

9.1.14.1 - 1.0

scpcli resourcemanager tag key list
[--key <value>]
[--region <value>]

Description

get tag key list

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
key
optional
stringTag keytag-key
region
optional
stringRegionkr-west1

Responses

NameDescriptionExample
countCount6
keysTag key list[“key1”, “key2”]

9.1.15 - ListTags

9.1.15.1 - 1.0

scpcli resourcemanager tag list
[--size <value>]
[--page <value>]
[--sort <value>]
[--account_id <value>]
[--key <value>]
[--value <value>]
[--resource_identifier <value>]
[--resource_type <value>]
[--service <value>]
[--offering <value>]
[--region <value>]

Description

get tag list

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
account_id
optional
stringAccount ID1234ab567cd64769e8f9g490hi304891
key
optional
stringTag keytag-key
value
optional
stringTag valuetag-value
resource_identifier
optional
stringResource IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
optional
stringResource typevirtual-server
service
optional
stringService namevirtualserver
offering
optional
stringSCP Offeringdev2
region
optional
stringRegionkr-west1

Responses

NameDescriptionExample
keyTag keytag-key
srnSRNsrn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496
valueTag valuetag-value

9.1.16 - ListTagValues

9.1.16.1 - 1.0

scpcli resourcemanager tag value list
[--key <value>]
[--region <value>]
[--value <value>]

Description

get tag value list

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
key
optional
stringTag keytag-key
region
optional
stringRegionkr-west1
value
optional
stringTag valuetag-value

Responses

NameDescriptionExample
countCount6
valuesTag value list[“value1”, “value2”]

9.1.17 - SetResourceGroup

9.1.17.1 - 1.0

scpcli resourcemanager resource group set
--resource_group_id <value>
--description <value>
[--resource_types <value>]
[--tags <value>]

Description

set resource_group

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
resource_group_id
required
stringResource Group ID1486t61d84b354fb9135cc467owe1346
description
required
stringResource Group descriptionresource group 1
resource_types
optional
arrayResource type list (service:resource_type)[
tags
optional
arrayTag list'{"key": "tag-key", "value": "tag-value"}'

9.1.18 - ShowComponentsTag

9.1.18.1 - 1.0

scpcli resourcemanager components tag show
--key <value>
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>

Description

get a specific components tag

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
key
required
stringTag key (base64 encoded KEY)dGFnLWtleQ==
resource_identifier
required
stringResource IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
stringResource typevirtual-server
service
required
stringService namevirtualserver
region
required
stringRegionkr-west1

Responses

NameDescriptionExample
contentTag

9.1.19 - ShowResource

9.1.19.1 - 1.0

scpcli resourcemanager resource show
--srn <value>

Description

get a specific resource

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==

Responses

NameDescriptionExample
resourceResource

9.1.20 - ShowResourceByComponents

9.1.20.1 - 1.0

scpcli resourcemanager resource show by components
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>

Description

get a specific resource

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
resource_identifier
required
stringResource IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
stringResource typevirtual-server
service
required
stringService namevirtualserver
region
required
stringRegionkr-west1

Responses

NameDescriptionExample
resourceResource

9.1.21 - ShowResourceGroup

9.1.21.1 - 1.0

scpcli resourcemanager resource group show
--resource_group_id <value>

Description

show a specific resource_group

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
resource_group_id
required
stringResource Group ID1486t61d84b354fb9135cc467owe1346

Responses

NameDescriptionExample
resource_groupResource Group

9.1.22 - ShowResourceTag

9.1.22.1 - 1.0

scpcli resourcemanager resource tag show
--key <value>
--srn <value>

Description

get a specific resource tag

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
key
required
stringTag key (base64 encoded KEY)dGFnLWtleQ==
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==

Responses

NameDescriptionExample
contentTag

9.1.23 - UpdateComponentsTags

9.1.23.1 - 1.0

scpcli resourcemanager components tag set
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
--tags <value>

Description

update components tags

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
resource_identifier
required
stringResource IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
stringResource typevirtual-server
service
required
stringService namevirtualserver
region
required
stringRegionkr-west1
tags
required
arrayTag list'{"key": "tag-key", "value": "tag-value"}'

9.1.24 - UpdateComponentsTagValue

9.1.24.1 - 1.0

scpcli resourcemanager components tag value set
--key <value>
--resource_identifier <value>
--resource_type <value>
--service <value>
--region <value>
--value <value>

Description

update components tag value

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
key
required
stringTag key (base64 encoded KEY)dGFnLWtleQ==
resource_identifier
required
stringResource IDz95fa561-11u3-4frw-962g-3b123123c496
resource_type
required
stringResource typevirtual-server
service
required
stringService namevirtualserver
region
required
stringRegionkr-west1
value
required
stringSRNtag-value

9.1.25 - UpdateResourceTags

9.1.25.1 - 1.0

scpcli resourcemanager resource tag set
--srn <value>
--tags <value>

Description

update resource tags

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
tags
required
arrayTag list'{"key": "tag-key", "value": "tag-value"}'

9.1.26 - UpdateResourceTagValue

9.1.26.1 - 1.0

scpcli resourcemanager resource tag value set
--key <value>
--srn <value>
--value <value>

Description

update resource tag value

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
key
required
stringTag key (base64 encoded KEY)dGFnLWtleQ==
srn
required
stringSRN (base64 encoded SRN)c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
value
required
stringSRNtag-value

9.1.27 - UpdateTags

9.1.27.1 - 1.0

scpcli resourcemanager tag set
--tags <value>

Description

update tags

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
tags
required
dictTag list-

10 - ServiceWatch

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of ServiceWatch service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.2CURRENT-
1.1SUPPORTED20260831
1.0DEPRECATED20260630

10.1 - CLIs

10.1.1 - CreateAlert

10.1.1.1 - 1.2

scpcli servicewatch alert create
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--name <value>
--metric_id <value>
--level <value>
[--description <value>]
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--recipient_ids <value>]
[--tags <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]

Description

Create an Alert

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
value
required
stringDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502
key
required
stringDimension KeyInstanceId
statistic
required
stringStatistic - SUM, AVG, MAX, MINAVG
period
required
integerPeriod (seconds)300
operator
required
stringOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
namespace_id
required
stringNamespace IDd583a229-9766-4eb8-96c4-ec389902ba3d
name
required
stringAlert NameAlert1
metric_id
required
stringMetric IDd91097ac-0387-4e69-adb2-7b8d453b8db5
level
required
stringAlert Level - HIGH, MIDDLE, LOWHIGH
description
optional
stringAlert DescriptionAlert1 Description
dimensions
optional
arrayList of Dimensions'{"key": "InstanceId", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}'
evaluation_count
optional
integerEvaluation Count for the Alert Condition3
individual_items
optional
arrayList of Individual Items'{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}'
lower_bound
optional
numberLower bound for the Alert range operator80.0
missing_data_option
optional
****Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNOREBREACHING
recipient_ids
optional
arrayList of User IDs1234da92-634a-4f8c-932e-9d650599ab1b
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'
threshold
optional
numberThreshold for the Alert Condition (except fro RANGE operator)80.0
upper_bound
optional
numberUpper bound for the Alert range operator90.0
violation_count
optional
integerViolation Count for the Alert Condition2

Responses

NameDescriptionExample
idAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47

10.1.2 - CreateCustomLogEvents

10.1.2.1 - 1.2

scpcli servicewatch logeventcustom create
--resourcelogs <value>

Description

Create Custom log events

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
resourcelogs
required
arrayResource Logs'{"resource": {"attributes": [{"key": "log_stream_value", "value": {"stringValue": "a1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "log_group_value", "value": {"stringValue": "b1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "account_id", "value": {"stringValue": "c1e2f3045678901a2b3c4d5e6f7a8b81"}}]}, "scopeLogs": [{"logRecords": [{"body": {"stringValue": "level=info otlp test log"}, "timeUnixNano": "1762336464000000000"}]}]}'

Responses

NameDescriptionExample
statusStatussuccess

10.1.2.2 - 1.1

scpcli servicewatch logeventcustom create
--resourcelogs <value>

Description

Create Custom log events

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
resourcelogs
required
arrayResource Logs'{"resource": {"attributes": [{"key": "log_stream_value", "value": {"stringValue": "a1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "log_group_value", "value": {"stringValue": "b1e2f3045678901a2b3c4d5e6f7a8b81"}}, {"key": "account_id", "value": {"stringValue": "c1e2f3045678901a2b3c4d5e6f7a8b81"}}]}, "scopeLogs": [{"logRecords": [{"body": {"stringValue": "level=info otlp test log"}, "timeUnixNano": "1762336464000000000"}]}]}'

Responses

NameDescriptionExample
statusStatussuccess

10.1.3 - CreateCustomLogStream

10.1.3.1 - 1.2

scpcli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>

Description

Create a custom log stream

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
log_stream_name
required
stringLog stream nametestls01
log_group_name
required
stringLog group nametestlg01

Responses

NameDescriptionExample
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
log_group_valueLog group valuefa6169af200b4d5db229aff384b2a028
log_stream_valueLog stream value551513c5182b45beb22eadb634cdccfb
requests_per_secondExport log requests per second500

10.1.3.2 - 1.1

scpcli servicewatch logstreamcustom create
--log_stream_name <value>
--log_group_name <value>

Description

Create a custom log stream

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
log_stream_name
required
stringLog stream nametestls01
log_group_name
required
stringLog group nametestlg01

Responses

NameDescriptionExample
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
log_group_valueLog group valuefa6169af200b4d5db229aff384b2a028
log_stream_valueLog stream value551513c5182b45beb22eadb634cdccfb
requests_per_secondExport log requests per second500

10.1.4 - CreateCustomMetricMetas

10.1.4.1 - 1.2

scpcli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>

Description

Create Custom Metric Metas

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
namespace
required
stringNamespaceMyCustom/filestorage
metricmetas
required
array'{"descriptionEn": "filestorage volume total byte", "descriptionKo": "\ud30c\uc77c\uc2a4\ud1a0\ub9ac\uc9c0 \ucd1d \ubc14\uc774\ud2b8 \uc218", "dimensions": [["image_id"]], "metricName": "Custom_filestorage_volume_total_byte", "storageResolution": 60, "unit": "Bytes"}'

Responses

NameDescriptionExample
codeRESPONSE STATUS CODE of MetricSuccess
messageMessage about Updated Unit Info[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes

10.1.4.2 - 1.1

scpcli servicewatch metriccustommeta create
--namespace <value>
--metricmetas <value>

Description

Create Custom Metric Metas

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
namespace
required
stringNamespaceMyCustom/filestorage
metricmetas
required
array'{"descriptionEn": "filestorage volume total byte", "descriptionKo": "\ud30c\uc77c\uc2a4\ud1a0\ub9ac\uc9c0 \ucd1d \ubc14\uc774\ud2b8 \uc218", "dimensions": [["image_id"]], "metricName": "Custom_filestorage_volume_total_byte", "storageResolution": 60, "unit": "Bytes"}'

Responses

NameDescriptionExample
codeRESPONSE STATUS CODE of MetricSuccess
messageMessage about Updated Unit Info[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes

10.1.5 - CreateCustomMetrics

10.1.5.1 - 1.2

scpcli servicewatch metriccustom create
--resource_metrics <value>

Description

Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
resource_metrics
required
arrayThe resourceMetrics field holds a set of all metric data associated with a specific resource'{"resource": {"attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}]}, "scope_metrics": [{"metrics": [{"description": "The total number of bytes read successfully.", "gauge": {"data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}]}, "name": "node_disk_read_bytes_total", "sum": {"aggregation_temporality": "2", "data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}], "is_monotonic": true}, "unit": "Bytes"}], "scope": {"name": "ServiceWatch-Agent", "version": "1.0.0"}}]}'

Responses

NameDescriptionExample

10.1.5.2 - 1.1

scpcli servicewatch metriccustom create
--resource_metrics <value>

Description

Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
resource_metrics
required
arrayThe resourceMetrics field holds a set of all metric data associated with a specific resource'{"resource": {"attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}]}, "scope_metrics": [{"metrics": [{"description": "The total number of bytes read successfully.", "gauge": {"data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}]}, "name": "node_disk_read_bytes_total", "sum": {"aggregation_temporality": "2", "data_points": [{"as_double": 0.75, "as_int": 10, "attributes": [{"key": "", "value": {"array_value": "", "bool_value": "", "byte_value": "", "double_value": "", "int_value": "", "kvlist_value": "", "string_value": ""}}], "start_time_unix_nano": "1753776789854000000", "time_unix_nano": "1753776789854000000"}], "is_monotonic": true}, "unit": "Bytes"}], "scope": {"name": "ServiceWatch-Agent", "version": "1.0.0"}}]}'

Responses

NameDescriptionExample

10.1.6 - CreateDashboard

10.1.6.1 - 1.2

scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

10.1.6.2 - 1.1

scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

10.1.6.3 - 1.0

scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

10.1.7 - CreateEventRule

10.1.7.1 - 1.2

scpcli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]

Description

Create an Event rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
name
required
stringEvent rule nameEvent rule 1
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
event_ruleEvent rule

10.1.7.2 - 1.1

scpcli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]

Description

Create an Event rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
name
required
stringEvent rule nameEvent rule 1
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
event_ruleEvent rule

10.1.7.3 - 1.0

scpcli servicewatch eventrule create
--service_id <value>
--name <value>
[--description <value>]
[--event_ids <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]
[--tags <value>]

Description

Create an Event rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
name
required
stringEvent rule nameEvent rule 1
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
event_ruleEvent rule

10.1.8 - CreateLogGroup

10.1.8.1 - 1.2

scpcli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]

Description

Create a Log group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
retention_period
required
integerLog group retention period365
name
required
stringLog group nametestlg01
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
log_groupLog group

10.1.8.2 - 1.1

scpcli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]

Description

Create a Log group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
retention_period
required
integerLog group retention period365
name
required
stringLog group nametestlg01
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
log_groupLog group

10.1.8.3 - 1.0

scpcli servicewatch loggroup create
--retention_period <value>
--name <value>
[--tags <value>]

Description

Create a Log group.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
retention_period
required
integerLog group retention period365
name
required
stringLog group nametestlg01
tags
optional
arrayList of Tags'{"key": "", "value": ""}'

Responses

NameDescriptionExample
log_groupLog group

10.1.9 - CreateLogStream

10.1.9.1 - 1.2

scpcli servicewatch logstream create
--log_group_id <value>
--name <value>

Description

Create a Log group log stream.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
name
required
stringLog stream nametestls01

Responses

NameDescriptionExample
log_streamLog stream

10.1.9.2 - 1.1

scpcli servicewatch logstream create
--log_group_id <value>
--name <value>

Description

Create a Log group log stream.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
name
required
stringLog stream nametestls01

Responses

NameDescriptionExample
log_streamLog stream

10.1.9.3 - 1.0

scpcli servicewatch logstream create
--log_group_id <value>
--name <value>

Description

Create a Log group log stream.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
name
required
stringLog stream nametestls01

Responses

NameDescriptionExample
log_streamLog stream

10.1.10 - DeleteAlerts

10.1.10.1 - 1.2

scpcli servicewatch alert delete-bulk
--ids <value>

Description

Delete Alerts

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Alert IDs0ad6da92-634a-4f8c-932e-9d650599ab1e

10.1.11 - DeleteBulkDashboards

10.1.11.1 - 1.2

scpcli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

10.1.11.2 - 1.1

scpcli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

10.1.11.3 - 1.0

scpcli servicewatch dashboard delete
--dashboard_ids <value>

Description

Delete bulk dashboards

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
dashboard_ids
required
arrayList of dashboard IDsb48e730a70e74f6aa3d2555000b5c22b

10.1.12 - DeleteEventRules

10.1.12.1 - 1.2

scpcli servicewatch eventrule delete-bulk
--ids <value>

Description

Delete Event rules.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Event rule IDs66d77b4e32d04558b2382b1d14765d86

10.1.12.2 - 1.1

scpcli servicewatch eventrule delete-bulk
--ids <value>

Description

Delete Event rules.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Event rule IDs66d77b4e32d04558b2382b1d14765d86

10.1.12.3 - 1.0

scpcli servicewatch eventrule delete-bulk
--ids <value>

Description

Delete Event rules.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Event rule IDs66d77b4e32d04558b2382b1d14765d86

10.1.13 - DeleteLogGroups

10.1.13.1 - 1.2

scpcli servicewatch loggroup delete-bulk
--ids <value>

Description

Delete Log groups.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Log group IDs602b39cb1d6b4b7fb0f18de43a4c689c

10.1.13.2 - 1.1

scpcli servicewatch loggroup delete-bulk
--ids <value>

Description

Delete Log groups.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Log group IDs602b39cb1d6b4b7fb0f18de43a4c689c

10.1.13.3 - 1.0

scpcli servicewatch loggroup delete-bulk
--ids <value>

Description

Delete Log groups.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
ids
required
arrayList of Log group IDs602b39cb1d6b4b7fb0f18de43a4c689c

10.1.14 - DeleteLogStreams

10.1.14.1 - 1.2

scpcli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>

Description

Delete Log group log streams.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
ids
required
arrayList of Log stream IDsb0fc99a46a2c44b8b22739b130853dd8

10.1.14.2 - 1.1

scpcli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>

Description

Delete Log group log streams.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
ids
required
arrayList of Log stream IDsb0fc99a46a2c44b8b22739b130853dd8

10.1.14.3 - 1.0

scpcli servicewatch logstream delete-bulk
--log_group_id <value>
--ids <value>

Description

Delete Log group log streams.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
ids
required
arrayList of Log stream IDsb0fc99a46a2c44b8b22739b130853dd8

10.1.15 - DownloadMetricDataImage

10.1.15.1 - 1.2

scpcli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]

Description

Download metric data image

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440
height
optional
integerChart Image Height(pixels)400
timezone
optional
stringTimezoneUTC
title
optional
stringChart TitleVirtual Server Metric Chart
width
optional
integerChart Image Width(pixels)600

Responses

NameDescriptionExample

10.1.15.2 - 1.1

scpcli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]

Description

Download metric data image

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440
height
optional
integerChart Image Height(pixels)400
timezone
optional
stringTimezoneUTC
title
optional
stringChart TitleVirtual Server Metric Chart
width
optional
integerChart Image Width(pixels)600

Responses

NameDescriptionExample

10.1.15.3 - 1.0

scpcli servicewatch metricdataimage list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>
[--height <value>]
[--timezone <value>]
[--title <value>]
[--width <value>]

Description

Download metric data image

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440
height
optional
integerChart Image Height(pixels)400
timezone
optional
stringTimezoneUTC
title
optional
stringChart TitleVirtual Server Metric Chart
width
optional
integerChart Image Width(pixels)600

Responses

NameDescriptionExample

10.1.16 - ListDashboards

10.1.16.1 - 1.2

scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
[--type <value>]
[--service_code <value>]

Description

Get list of dashboards

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortname:asc or modified_at:desc
name
optional
stringDashboard's nameMyProd
name_like
optional
stringWildcard Search for Dashboard NamesMyProd
favorite_enabled
optional
booleanWhether it is a favorite dashboardTrue
type
optional
stringDashboard typeCustom
service_code
optional
stringAssociated service codevirtualserver

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
created_atCreated date time
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
nameDashboard’s nameProduction-Web-Servers
typeDashboard typeCustom

10.1.16.2 - 1.1

scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]

Description

Get list of dashboards

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortname:asc or modified_at:desc
name
optional
stringDashboard's nameMyProd
name_like
optional
stringWildcard Search for Dashboard NamesMyProd
favorite_enabled
optional
booleanWhether it is a favorite dashboardTrue

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
created_atCreated date time
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
nameDashboard’s nameProduction-Web-Servers
typeDashboard typeCustom

10.1.16.3 - 1.0

scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]

Description

Get list of dashboards

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortname:asc or modified_at:desc
name
optional
stringDashboard's nameMyProd
name_like
optional
stringWildcard Search for Dashboard NamesMyProd
favorite_enabled
optional
booleanWhether it is a favorite dashboardTrue

Responses

NameDescriptionExample
idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
created_atCreated date time
favorite_enabledWhether it is a favorite dashboardTrue
modified_atModified date time
nameDashboard’s nameProduction-Web-Servers
typeDashboard typeCustom

10.1.17 - ListLogGroups

10.1.17.1 - 1.2

scpcli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]

Description

Get list of Log groups.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ids
optional
arrayList of Log group IDs6
name
optional
stringLog group nametestlg01
retention_periods
optional
arrayList of Log group retention periods-

Responses

NameDescriptionExample
idLog group IDbce52822147744b4afe0187164caa2e8
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameLog group nametestlg01
retention_periodLog group retention period365
retention_period_nameLog group retention period name1 year
statusLog group statusACTIVE

10.1.17.2 - 1.1

scpcli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]

Description

Get list of Log groups.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ids
optional
arrayList of Log group IDs6
name
optional
stringLog group nametestlg01
retention_periods
optional
arrayList of Log group retention periods-

Responses

NameDescriptionExample
idLog group IDbce52822147744b4afe0187164caa2e8
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameLog group nametestlg01
retention_periodLog group retention period365
retention_period_nameLog group retention period name1 year
statusLog group statusACTIVE

10.1.17.3 - 1.0

scpcli servicewatch loggroup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ids <value>]
[--name <value>]
[--retention_periods <value>]

Description

Get list of Log groups.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ids
optional
arrayList of Log group IDs6
name
optional
stringLog group nametestlg01
retention_periods
optional
arrayList of Log group retention periods-

Responses

NameDescriptionExample
idLog group IDbce52822147744b4afe0187164caa2e8
account_idAccount ID1bcf39b344ac41cbaf0466ff0d2bebad
created_atCreated date time
created_byCreator IDf4b8a4c4017f4f8d8399f0c02582ae47
modified_atModified date time
modified_byModifier IDf4b8a4c4017f4f8d8399f0c02582ae47
nameLog group nametestlg01
retention_periodLog group retention period365
retention_period_nameLog group retention period name1 year
statusLog group statusACTIVE

10.1.18 - ListMetricData

10.1.18.1 - 1.2

scpcli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>

Description

Get metric data list

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440

Responses

NameDescriptionExample
display_nameMetric Display NameVirtual Server
status
valuesList of Metric Series Values[[1640995200, “45.5”]]

10.1.18.2 - 1.1

scpcli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>

Description

Get metric data list

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440

Responses

NameDescriptionExample
display_nameMetric Display NameVirtual Server
status
valuesList of Metric Series Values[[1640995200, “45.5”]]

10.1.18.3 - 1.0

scpcli servicewatch metricdata list
--statistic_type <value>
--start <value>
--period <value>
--metrics <value>
--end <value>

Description

Get metric data list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
statistic_type
required
stringMetric Statistics TypeAVG
start
required
integerMetric Start Time - Unix Timestamp1640995200
period
required
integerStatistic Period300
metrics
required
array```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server
end
required
integerMetric End Time - Unix Timestamp1640995440

Responses

NameDescriptionExample
display_nameMetric Display NameVirtual Server
status
valuesList of Metric Series Values[[1640995200, “45.5”]]

10.1.19 - ListMetricInfos

10.1.19.1 - 1.2

scpcli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]

Description

Get metric list

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage/Core[Basic]
namespaces
optional
arrayList of Namespace'{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}'
resource_id
optional
stringResource ID10bf5d24-0f20-4066-bb0b-de2b1d6ff502
resource_name
optional
stringResource NameVirtualServer01
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'

Responses

NameDescriptionExample
idNamespace IDd583a229-9766-4eb8-96c4-ec389902ba3d
dimensions
nameNamespaceVirtual Server
service_name

10.1.19.2 - 1.1

scpcli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]

Description

Get metric list

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage/Core[Basic]
namespaces
optional
arrayList of Namespace'{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}'
resource_id
optional
stringResource ID10bf5d24-0f20-4066-bb0b-de2b1d6ff502
resource_name
optional
stringResource NameVirtualServer01
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'

Responses

NameDescriptionExample
idNamespace IDd583a229-9766-4eb8-96c4-ec389902ba3d
dimensions
nameNamespaceVirtual Server
service_name

10.1.19.3 - 1.0

scpcli servicewatch metricinfo list
[--metric_name <value>]
[--namespaces <value>]
[--resource_id <value>]
[--resource_name <value>]
[--tags <value>]

Description

Get metric list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
metric_name
optional
stringMetric NameCPU Usage/Core[Basic]
namespaces
optional
arrayList of Namespace'{"dimensions": "[\"resource_id\"]", "name": "Virtual Server"}'
resource_id
optional
stringResource ID10bf5d24-0f20-4066-bb0b-de2b1d6ff502
resource_name
optional
stringResource NameVirtualServer01
tags
optional
arrayList of Tags'{"key": "key01", "value": "value01"}'

Responses

NameDescriptionExample
idNamespace IDd583a229-9766-4eb8-96c4-ec389902ba3d
dimensions
nameNamespaceVirtual Server
service_name

10.1.20 - SetAlert

10.1.20.1 - 1.2

scpcli servicewatch alert set
--id <value>
--value <value>
--key <value>
--statistic <value>
--period <value>
--operator <value>
--namespace_id <value>
--metric_id <value>
--level <value>
[--dimensions <value>]
[--evaluation_count <value>]
[--individual_items <value>]
[--lower_bound <value>]
[--missing_data_option <value>]
[--threshold <value>]
[--upper_bound <value>]
[--violation_count <value>]

Description

Set the Alert

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e
value
required
stringDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502
key
required
stringDimension KeyInstanceId
statistic
required
stringStatistic - SUM, AVG, MAX, MINAVG
period
required
integerPeriod (seconds)300
operator
required
stringOperator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGERANGE
namespace_id
required
stringNamespace IDd583a229-9766-4eb8-96c4-ec389902ba3d
metric_id
required
stringMetric IDd91097ac-0387-4e69-adb2-7b8d453b8db5
level
required
stringAlert Level - HIGH, MIDDLE, LOWHIGH
dimensions
optional
arrayList of Dimensions'{"key": "InstanceId", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}'
evaluation_count
optional
integerEvaluation Count for the Alert Condition3
individual_items
optional
arrayList of Individual Items'{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}'
lower_bound
optional
numberLower bound for the Alert range operator80.0
missing_data_option
optional
****Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNOREBREACHING
threshold
optional
numberThreshold for the Alert Condition (except fro RANGE operator)80.0
upper_bound
optional
numberUpper bound for the Alert range operator90.0
violation_count
optional
integerViolation Count for the Alert Condition2

Responses

NameDescriptionExample
keyDimension KeyInstanceId
valueDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502

10.1.21 - SetAlertActivated

10.1.21.1 - 1.2

scpcli servicewatch alert-activated set
--id <value>
--activated_yn <value>

Description

Set the Alert Activated

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e
activated_yn
required
stringWhether the Alert is activated or notY

Responses

NameDescriptionExample
idAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e
activated_ynWhether the Alert is activated or notY
modified_atModified date time2026-03-13T02:34:40.008404

10.1.22 - SetAlertDescription

10.1.22.1 - 1.2

scpcli servicewatch alert-description set
--id <value>
[--description <value>]

Description

Set the Alert Description

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e
description
optional
stringAlert DescriptionAlert1 Description

Responses

NameDescriptionExample
idAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e
descriptionAlert DescriptionAlert1 Description
modified_atModified date time2026-03-13T02:34:40.006634

10.1.23 - SetDashboard

10.1.23.1 - 1.2

scpcli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]

Description

Set dashboard

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b
name
optional
stringDashboard's nameRenamed-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

10.1.23.2 - 1.1

scpcli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]

Description

Set dashboard

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b
name
optional
stringDashboard's nameRenamed-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

10.1.23.3 - 1.0

scpcli servicewatch dashboard set
--dashboard_id <value>
[--name <value>]
[--widgets <value>]

Description

Set dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b
name
optional
stringDashboard's nameRenamed-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

10.1.24 - SetEventRule

10.1.24.1 - 1.2

scpcli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]

Description

Set the Event rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
active_yn
optional
****Whether the Event rule is activeY
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
none_attributes
optional
arrayList of attributes to assign to Nonedescription
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a

Responses

NameDescriptionExample
event_ruleEvent rule

10.1.24.2 - 1.1

scpcli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]

Description

Set the Event rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
active_yn
optional
****Whether the Event rule is activeY
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
none_attributes
optional
arrayList of attributes to assign to Nonedescription
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a

Responses

NameDescriptionExample
event_ruleEvent rule

10.1.24.3 - 1.0

scpcli servicewatch eventrule set
--event_rule_id <value>
--service_id <value>
[--active_yn <value>]
[--description <value>]
[--event_ids <value>]
[--none_attributes <value>]
[--recipient_ids <value>]
[--resource_type_id <value>]
[--srn_list <value>]

Description

Set the Event rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f
service_id
required
stringService ID2778de83d7e247609445bbd570a4eba9
active_yn
optional
****Whether the Event rule is activeY
description
optional
stringEvent rule descriptionEvent rule 1 description
event_ids
optional
arrayList of Event IDs014cb88ca2a9420e840d5c9ac16cac89
none_attributes
optional
arrayList of attributes to assign to Nonedescription
recipient_ids
optional
arrayNotification recipient IDs947c6a8559434505b28a5e21fff463d0
resource_type_id
optional
stringResource type ID596bf16709e84e27b7df397bf59b877c
srn_list
optional
arrayList of SDS cloud Resource Namessrn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a

Responses

NameDescriptionExample
event_ruleEvent rule

10.1.25 - SetLogGroup

10.1.25.1 - 1.2

scpcli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>

Description

Set the Log group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
retention_period
required
integerLog group retention period365

Responses

NameDescriptionExample
log_groupLog group

10.1.25.2 - 1.1

scpcli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>

Description

Set the Log group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
retention_period
required
integerLog group retention period365

Responses

NameDescriptionExample
log_groupLog group

10.1.25.3 - 1.0

scpcli servicewatch loggroup set
--log_group_id <value>
--retention_period <value>

Description

Set the Log group.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8
retention_period
required
integerLog group retention period365

Responses

NameDescriptionExample
log_groupLog group

10.1.26 - ShowAgentDownloadLink

10.1.26.1 - 1.2

scpcli servicewatch show agent download link

Description

Show link to agent download

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Responses

NameDescriptionExample
download_linkURL to download agenthttps://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/1.0/ServiceWatch_Agent.zip

10.1.26.2 - 1.1

scpcli servicewatch show agent download link

Description

Show link to agent download

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Responses

NameDescriptionExample
download_linkURL to download agenthttps://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/1.0/ServiceWatch_Agent.zip

10.1.27 - ShowAlert

10.1.27.1 - 1.2

scpcli servicewatch alert show
--id <value>

Description

Show the Alert

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
id
required
stringAlert ID0ad6da92-634a-4f8c-932e-9d650599ab1e

Responses

NameDescriptionExample
keyDimension KeyInstanceId
valueDimension Value10bf5d24-0f20-4066-bb0b-de2b1d6ff502

10.1.28 - ShowDashboard

10.1.28.1 - 1.2

scpcli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

10.1.28.2 - 1.1

scpcli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

10.1.28.3 - 1.0

scpcli servicewatch dashboard show
--dashboard_id <value>

Description

Show dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
dashboard_id
required
stringDashboard's unique IDb48e730a70e74f6aa3d2555000b5c22b

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

10.1.29 - ShowEventRule

10.1.29.1 - 1.2

scpcli servicewatch eventrule show
--event_rule_id <value>

Description

Show the Event rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
event_rule_id
required
stringEvent rule IDb73f95c698f540dab18860f72fafd03f

Responses

NameDescriptionExample
event_ruleEvent rule

10.1.30 - ShowLogGroup

10.1.30.1 - 1.2

scpcli servicewatch loggroup show
--log_group_id <value>

Description

Show the Log group.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8

Responses

NameDescriptionExample
log_groupLog group

10.1.31 - ShowLogStream

10.1.31.1 - 1.2

scpcli servicewatch logstream show
--log_stream_id <value>
--log_group_id <value>

Description

Show the Log group log stream

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
log_stream_id
required
stringLog stream IDb0fc99a46a2c44b8b22739b130853dd8
log_group_id
required
stringLog group IDbce52822147744b4afe0187164caa2e8

Responses

NameDescriptionExample
log_streamLog stream

11 - Support

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Support service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.0CURRENT-

11.1 - CLIs

11.1.1 - Get Inquiry List

11.1.1.1 - 1.0

scpcli support inquiry list
[--size <value>]
[--page <value>]
[--sort <value>]
[--title <value>]
[--state <value>]
[--inquiry_type <value>]
[--region_id <value>]
[--created_at <value>]
[--filter_inquiry_codes <value>]
[--filter_states <value>]

Description

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
title
optional
stringtitleVM usage inquiry
state
optional
stringstateCLOSED
inquiry_type
optional
stringinquiry typeGeneral Inquiry - Account and connection inquiry
region_id
optional
stringregion idkr-west1
created_at
optional
stringcreated at2024-06-01T00:12:57.000000Z
filter_inquiry_codes
optional
stringfilter inquiry codesFL01,FL02
filter_states
optional
stringfilter statesTODO,INPROGRESS

Responses

NameDescriptionExample
ididsr-240530-00028-nuri
account_idaccount id2010571da2f7458e97c3b881b2362b72
closed_atclosed at2024-06-27T08:12:57.000000Z
contentscontentsVM usage inquiry
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
filesfile list
inquiry_codeinquiry codeG01
inquiry_typeinquiry typeGeneral Inquiry - Account and connection inquiry
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_idregion idkr-west1
resource_nameresource namelb1
service_categoryservice categoryNetworking
service_itemservice itemLoad Balancer
statestateCLOSED
titletitleVM usage inquiry

11.1.2 - Get Service Request List

11.1.2.1 - 1.0

scpcli support service request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--filter_operation_type_ids <value>]
[--filter_service_item_ids <value>]
[--filter_title <value>]
[--filter_states <value>]
[--from_created_at <value>]
[--to_created_at <value>]
[--operation_type <value>]
[--service_item_name <value>]
[--title <value>]
[--state <value>]

Description

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
filter_operation_type_ids
optional
stringoperation type idse8fea87728164808860ad81c6ce779b6
filter_service_item_ids
optional
stringservice item id listVIRTUAL_SERVER,LOAD_BALANCER
filter_title
optional
stringtitleVirtual Server operation related
filter_states
optional
stringfilter statesREQUESTING,CLOSED
from_created_at
optional
stringfrom created at2024-07-01T00:00:00Z
to_created_at
optional
stringto created at2024-07-05T23:59:59Z
operation_type
optional
stringoperation typePlacement Group Set Up Request
service_item_name
optional
stringservice itemLoad Balancer
title
optional
stringtitleVirtual Server operation related
state
optional
stringstateREQUESTING

Responses

NameDescriptionExample
idid007d8cc7d60c4b26bb5a833b06686db3
account_idaccount id2010571da2f7458e97c3b881b2362b72
account_nameaccount namedev_project
closed_atclosed at2024-06-27T08:12:57.000000Z
contentscontentsI need assistance with working with Virtual Server.
created_atcreated at2024-06-01T00:12:57.000000Z
created_bycreated bye3bff0c980dc41b2b6f3ac080b6d3ba0
created_by_namecreated by name and emailKimSamSung(test@samsung.com)
filesfile list
iops_resultiops resultProcessing completed.
iops_sr_idiops sr idSR0002834921
modified_atmodified at2024-06-11T00:12:57.000000Z
modified_bymodified bye3bff0c980dc41b2b6f3ac080b6d3ba0
operation_typeoperation typePlacement Group Set Up Request
regionregionkr-west1
service_category_nameservice categoryNetworking
service_item_nameservice itemLoad Balancer
statestateACTIVE
template_idtemplate ide8fea87728164808860ad81c6ce779b6
titletitleVirtual Server operation related

11.1.3 - Show Inquiry

11.1.3.1 - 1.0

scpcli support inquiry show
--inquiry_id <value>

Description

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
inquiry_id
required
stringidsr-240530-00028-nuri

Responses

NameDescriptionExample
ididFile-008ccb7ff65244689dacd605fafec92f
file_namenametest.txt
sizesize298426

11.1.4 - Show Service Request

11.1.4.1 - 1.0

scpcli support service request show
--service_request_id <value>

Description

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
service_request_id
required
stringid007d8cc7d60c4b26bb5a833b06686db3

Responses

NameDescriptionExample
ididFile-008ccb7ff65244689dacd605fafec92f
file_namenametest.txt
sizesize298426