This is the multi-page printable view of this section. Click here to print.
Management
- 1: Cloud Control
- 1.1: CLIs
- 1.1.1: AddBaselineAssignment
- 1.1.2: CreateAccountFactoryAccount
- 1.1.3: CreateLandingZone
- 1.1.4: DeleteLandingZone
- 1.1.5: DisableGuardrailBindings
- 1.1.6: EnableGuardrailBindings
- 1.1.7: ListBaselineAssignments
- 1.1.8: ListGuardrails
- 1.1.9: ListGuardrailsForTarget
- 1.1.10: ListTargetsForGuardrail
- 1.1.11: RemoveBaselineAssignment
- 1.1.11.1: 1.1
- 1.1.12: SetLandingZone
- 1.1.12.1: 1.1
- 1.1.13: ShowGuardrail
- 1.1.14: ShowLandingZone
- 1.1.15: UpdateBaselineAssignment
- 2: Cloud Monitoring
- 2.1: CLIs
- 2.1.1: CreateEventPolicy
- 2.1.1.1: 1.0
- 2.1.2: DeleteEventPolicy
- 2.1.2.1: 1.0
- 2.1.3: ListAccountEvents
- 2.1.3.1: 1.0
- 2.1.4: ListAccountMember
- 2.1.4.1: 1.0
- 2.1.5: ListAccountResources
- 2.1.5.1: 1.0
- 2.1.6: ListAddressBookMembers
- 2.1.6.1: 1.0
- 2.1.7: ListAddressBooks
- 2.1.7.1: 1.0
- 2.1.8: ListEventPolicies
- 2.1.8.1: 1.0
- 2.1.9: ListEventPolicyHistories
- 2.1.9.1: 1.0
- 2.1.10: ListEventPolicyNotification
- 2.1.10.1: 1.0
- 2.1.11: ListMetricPefData
- 2.1.11.1: 1.0
- 2.1.12: ListMetrics
- 2.1.12.1: 1.0
- 2.1.13: ListResourceEvents
- 2.1.13.1: 1.0
- 2.1.14: ListService
- 2.1.14.1: 1.0
- 2.1.15: SetEventPolicy
- 2.1.15.1: 1.0
- 2.1.16: ShowEventNotificationStates
- 2.1.16.1: 1.0
- 2.1.17: ShowEventPolicy
- 2.1.17.1: 1.0
- 2.1.18: ShowResourceEvent
- 2.1.18.1: 1.0
- 3: IAM
- 3.1: CLIs
- 3.1.1: Add a permission into the resource based policy
- 3.1.2: Add a user to a group
- 3.1.3: Assign policies to the group
- 3.1.4: Assign policies to user
- 3.1.5: Attach policies to Role
- 3.1.6: Create a group
- 3.1.7: Create a policy
- 3.1.8: Create a saml provider
- 3.1.9: Create an access key
- 3.1.10: Create IAM user
- 3.1.11: Create role
- 3.1.12: Delete bulk role
- 3.1.13: Delete IAM user
- 3.1.14: Delete IAM users
- 3.1.15: Delete role
- 3.1.16: Delete the policy
- 3.1.17: Delete the resource based policy
- 3.1.18: Delete user policy
- 3.1.19: Detach policies to Role
- 3.1.20: Detach policy to Role
- 3.1.21: Get a Group
- 3.1.22: Get a specific policy binding list
- 3.1.23: Get an access key
- 3.1.24: Get endpoint list
- 3.1.25: Get IAM users
- 3.1.26: Get policy list
- 3.1.27: Get role
- 3.1.28: Get role list
- 3.1.29: Get Role Policy-Binding list
- 3.1.30: Get saml provider information
- 3.1.31: Get service account
- 3.1.32: Get user policy-binding list
- 3.1.33: Group Member list
- 3.1.34: List access keys
- 3.1.35: List Groups
- 3.1.36: List IAM users
- 3.1.37: List saml providers
- 3.1.38: List service accounts
- 3.1.39: Modify a Group
- 3.1.40: Query policy list
- 3.1.41: Remove a permission into the resource based policy
- 3.1.42: Remove a User from a Group
- 3.1.43: Remove policies
- 3.1.44: Remove policy assignment from group
- 3.1.45: Remove saml providers
- 3.1.46: Remove the access key
- 3.1.47: Remove the access keys
- 3.1.48: Remove the Group
- 3.1.49: Send Temporary Access Key OTP
- 3.1.50: Set a permission into the resource based policy
- 3.1.51: Set an access key
- 3.1.52: Set role
- 3.1.53: Set role trust policy
- 3.1.54: Set the policy
- 3.1.55: Set the resource based policy
- 3.1.56: Show group policy
- 3.1.57: Show the policy
- 3.1.58: Show the resource based policy
- 3.1.59: Update IAM user
- 3.1.60: Update IAM user password
- 3.1.61: Update saml provider information
- 4: ID Center
- 4.1: CLIs
- 4.1.1: CreateAccountAssignment
- 4.1.2: CreateBulkGroupUsers
- 4.1.3: CreateGroup
- 4.1.4: CreateInstance
- 4.1.5: CreatePermissionSet
- 4.1.6: CreateUser
- 4.1.7: DeleteAccountAssignment
- 4.1.8: DeleteBulkAccountAssignment
- 4.1.9: DeleteBulkGroups
- 4.1.10: DeleteBulkGroupUsers
- 4.1.11: DeleteBulkUsers
- 4.1.12: DeleteGroup
- 4.1.13: DeleteInstance
- 4.1.14: DeletePermissionSet
- 4.1.15: DeletePermissionSetPolicies
- 4.1.16: DeleteUser
- 4.1.17: ListAccountAssignments
- 4.1.18: ListGroups
- 4.1.19: ListGroupUsers
- 4.1.20: ListInstances
- 4.1.21: ListPermissionSetPolicies
- 4.1.22: ListPermissionSets
- 4.1.23: ListUsers
- 4.1.24: SetGroup
- 4.1.25: SetPermissionSet
- 4.1.26: SetPermissionSetPolicies
- 4.1.27: SetUser
- 4.1.28: ShowGroup
- 4.1.29: ShowInstance
- 4.1.30: ShowPermissionSet
- 4.1.31: ShowUser
- 5: Logging&Audit
- 5.1: CLIs
- 5.1.1: CreateTrail
- 5.1.2: DeleteTrail
- 5.1.3: DownloadLogs
- 5.1.4: ListLogs
- 5.1.5: ListTrails
- 5.1.6: SetTrail
- 5.1.7: ShowLog
- 5.1.8: ShowTrail
- 5.1.9: StartTrail
- 5.1.10: StopTrail
- 6: Network Logging
- 6.1: CLIs
- 6.1.1: Create Network Logging Storage
- 6.1.1.1: 1.0
- 6.1.2: Delete Network Logging Storage
- 6.1.2.1: 1.0
- 6.1.3: List Network Logging Configurations
- 6.1.3.1: 1.0
- 6.1.4: List Network Logging Storages
- 6.1.4.1: 1.0
- 7: Organization
- 7.1: CLIs
- 7.1.1: AcceptInvitation
- 7.1.2: AttachPolicyBindings
- 7.1.3: CancelInvitations
- 7.1.4: CreateAccount
- 7.1.5: CreateDelegationPolicy
- 7.1.6: CreateInvitation
- 7.1.7: CreateOrganization
- 7.1.8: CreateOrganizationUnit
- 7.1.9: CreateServiceControlPolicy
- 7.1.10: DeclineInvitation
- 7.1.11: DeleteAccount
- 7.1.11.1: 1.2
- 7.1.12: DeleteDelegationPolicy
- 7.1.13: DeleteOrganization
- 7.1.14: DeleteOrganizationUnits
- 7.1.15: DeleteServiceControlPolicies
- 7.1.16: LeaveOrganization
- 7.1.17: ListAccountInvitations
- 7.1.18: ListAccounts
- 7.1.19: ListOrganizationInvitations
- 7.1.20: ListOrganizations
- 7.1.21: ListOrganizationUnits
- 7.1.22: ListParents
- 7.1.23: ListPoliciesForTarget
- 7.1.24: ListServiceControlPolicies
- 7.1.25: ListTargetsForPolicy
- 7.1.26: MoveAccount
- 7.1.27: RemoveAccounts
- 7.1.28: RemovePolicyBindings
- 7.1.29: SetDelegationPolicy
- 7.1.30: SetOrganization
- 7.1.31: SetOrganizationUnit
- 7.1.32: SetServiceControlPolicy
- 7.1.33: ShowAccount
- 7.1.34: ShowDelegationPolicy
- 7.1.35: ShowOrganization
- 7.1.36: ShowOrganizationUnit
- 7.1.37: ShowServiceControlPolicy
- 8: Quota Service
- 8.1: CLIs
- 8.1.1: ListAccountQuota
- 8.1.2: ListQuotaRequests
- 8.1.3: ShowAccountQuota
- 8.1.4: ShowQuotaRequest
- 9: Resource Manager
- 9.1: CLIs
- 9.1.1: CreateResourceGroup
- 9.1.1.1: 1.0
- 9.1.2: DeleteComponentsTag
- 9.1.2.1: 1.0
- 9.1.3: DeleteComponentsTags
- 9.1.3.1: 1.0
- 9.1.4: DeleteResourceGroup
- 9.1.4.1: 1.0
- 9.1.5: DeleteResourceGroups
- 9.1.5.1: 1.0
- 9.1.6: DeleteResourceTag
- 9.1.6.1: 1.0
- 9.1.7: DeleteResourceTags
- 9.1.7.1: 1.0
- 9.1.8: DeleteTags
- 9.1.8.1: 1.0
- 9.1.9: ListComponentsTags
- 9.1.9.1: 1.0
- 9.1.10: ListResourceGroupResources
- 9.1.10.1: 1.0
- 9.1.11: ListResourceGroups
- 9.1.11.1: 1.0
- 9.1.12: ListResources
- 9.1.12.1: 1.0
- 9.1.13: ListResourceTags
- 9.1.13.1: 1.0
- 9.1.14: ListTagKeys
- 9.1.14.1: 1.0
- 9.1.15: ListTags
- 9.1.15.1: 1.0
- 9.1.16: ListTagValues
- 9.1.16.1: 1.0
- 9.1.17: SetResourceGroup
- 9.1.17.1: 1.0
- 9.1.18: ShowComponentsTag
- 9.1.18.1: 1.0
- 9.1.19: ShowResource
- 9.1.19.1: 1.0
- 9.1.20: ShowResourceByComponents
- 9.1.20.1: 1.0
- 9.1.21: ShowResourceGroup
- 9.1.21.1: 1.0
- 9.1.22: ShowResourceTag
- 9.1.22.1: 1.0
- 9.1.23: UpdateComponentsTags
- 9.1.23.1: 1.0
- 9.1.24: UpdateComponentsTagValue
- 9.1.24.1: 1.0
- 9.1.25: UpdateResourceTags
- 9.1.25.1: 1.0
- 9.1.26: UpdateResourceTagValue
- 9.1.26.1: 1.0
- 9.1.27: UpdateTags
- 9.1.27.1: 1.0
- 10: ServiceWatch
- 10.1: CLIs
- 10.1.1: CreateAlert
- 10.1.1.1: 1.2
- 10.1.2: CreateCustomLogEvents
- 10.1.3: CreateCustomLogStream
- 10.1.4: CreateCustomMetricMetas
- 10.1.5: CreateCustomMetrics
- 10.1.6: CreateDashboard
- 10.1.7: CreateEventRule
- 10.1.8: CreateLogGroup
- 10.1.9: CreateLogStream
- 10.1.10: DeleteAlerts
- 10.1.10.1: 1.2
- 10.1.11: DeleteBulkDashboards
- 10.1.12: DeleteEventRules
- 10.1.13: DeleteLogGroups
- 10.1.14: DeleteLogStreams
- 10.1.15: DownloadMetricDataImage
- 10.1.16: ListDashboards
- 10.1.17: ListLogGroups
- 10.1.18: ListMetricData
- 10.1.19: ListMetricInfos
- 10.1.20: SetAlert
- 10.1.20.1: 1.2
- 10.1.21: SetAlertActivated
- 10.1.21.1: 1.2
- 10.1.22: SetAlertDescription
- 10.1.22.1: 1.2
- 10.1.23: SetDashboard
- 10.1.24: SetEventRule
- 10.1.25: SetLogGroup
- 10.1.26: ShowAgentDownloadLink
- 10.1.27: ShowAlert
- 10.1.27.1: 1.2
- 10.1.28: ShowDashboard
- 10.1.29: ShowEventRule
- 10.1.29.1: 1.2
- 10.1.30: ShowLogGroup
- 10.1.30.1: 1.2
- 10.1.31: ShowLogStream
- 10.1.31.1: 1.2
- 11: Support
- 11.1: CLIs
- 11.1.1: Get Inquiry List
- 11.1.1.1: 1.0
- 11.1.2: Get Service Request List
- 11.1.2.1: 1.0
- 11.1.3: Show Inquiry
- 11.1.3.1: 1.0
- 11.1.4: Show Service Request
- 11.1.4.1: 1.0
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.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20251231 |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| assignment_id required | string | Root/Organization Unit/Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| resource_type required | string | OU/Account | OU |
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn optional | **** | Terms Agreement YN | Y |
| parent_unit_id optional | string | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| sso_user_name optional | string | ID Center User Name | testuser |
| sso_user_real_name optional | string | ID Center User Real Name | test user |
Responses
| Name | Description | Example |
|---|---|---|
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
| resource_id | Root/Organization Unit/Account ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| resource_type | OU/Account | OU |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| assignment_id required | string | Root/Organization Unit/Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| resource_type required | string | OU/Account | OU |
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn optional | **** | Terms Agreement YN | Y |
| parent_unit_id optional | string | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| sso_user_name optional | string | ID Center User Name | testuser |
| sso_user_real_name optional | string | ID Center User Real Name | test user |
Responses
| Name | Description | Example |
|---|---|---|
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
| resource_id | Root/Organization Unit/Account ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| resource_type | OU/Account | OU |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_unit_id required | string | Parent Organization Unit ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| name required | string | Account Name | foo-account |
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| email optional | string | Account Email | myaccount@example.com |
| sso_user_email optional | string | ID Center User Email | user_email@example.com |
| sso_user_name optional | string | ID Center User Name | John Doe |
| sso_user_real_name optional | string | ID Center User Real Name | John Doe |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_unit_id required | string | Parent Organization Unit ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| name required | string | Account Name | foo-account |
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| email optional | string | Account Email | myaccount@example.com |
| sso_user_email optional | string | ID Center User Email | user_email@example.com |
| sso_user_name optional | string | ID Center User Name | John Doe |
| sso_user_real_name optional | string | ID Center User Real Name | John Doe |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sso_type required | string | Account Access Configuration | ID_CENTER |
| log_archive_login_id required | string | Login ID | log-archive@samsung.com |
| log_archive_account_name required | string | Log Archive Account Name | LOG_ARCHIVE |
| detective_guardrail_status required | string | Detective Guardrail Status | ENABLED |
| basic_ou_name required | string | Basic Organization Unit Name | Security |
| audit_login_id required | string | Login ID | audit@samsung.com |
| audit_account_name required | string | Audit Account Name | AUDIT |
| agree_yn required | string | Terms Agreement YN | Y |
| additional_ou_name required | string | Additional Organization Unit Name | Sandbox |
Responses
| Name | Description | Example |
|---|---|---|
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
| landing_zone_id | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sso_type required | string | Account Access Configuration | ID_CENTER |
| log_archive_login_id required | string | Login ID | log-archive@samsung.com |
| log_archive_account_name required | string | Log Archive Account Name | LOG_ARCHIVE |
| basic_ou_name required | string | Basic Organization Unit Name | Security |
| audit_login_id required | string | Login ID | audit@samsung.com |
| audit_account_name required | string | Audit Account Name | AUDIT |
| agree_yn required | string | Terms Agreement YN | Y |
| additional_ou_name required | string | Additional Organization Unit Name | Sandbox |
Responses
| Name | Description | Example |
|---|---|---|
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
| landing_zone_id | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_ids required | array | Target Info | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| guardrail_ids required | array | Guardrail List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_ids required | array | Target Info | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| guardrail_ids required | array | Guardrail List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_ids required | array | Target Info | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| guardrail_ids required | array | Guardrail List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | Error Code | CloudControl.AlreadyEnabledGuardrails |
| failed_caused | Failure Cause | guardrail already enabled |
| guardrail_id | Guardrail ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| response | ||
| unit_id | Target ID | ou-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_ids required | array | Target Info | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| guardrail_ids required | array | Guardrail List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | Error Code | CloudControl.AlreadyEnabledGuardrails |
| failed_caused | Failure Cause | guardrail already enabled |
| guardrail_id | Guardrail ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| response | ||
| unit_id | Target ID | ou-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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| resource_type optional | **** | OU/Account | OU |
| assignment_id optional | string | Root/Organization Unit/Account ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| status optional | **** | State | REGISTRATION_FAILED |
Responses
| Name | Description | Example |
|---|---|---|
| id | Root/Organization Unit/Account ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| account_assigned_count | Registered Account Count | 3 |
| account_count | Total Account Count | 4 |
| detective_guardrail_status | Detective Guardrail Status | ENABLED |
| detective_guardrail_type | Detective Guardrail Type | SSI |
| ou_assigned_count | Registered Organization Unit Count | 5 |
| ou_count | Total Organization Unit Count | 10 |
| preventive_guardrail_activated_count | Activated Preventive Guardrail Count | 8 |
| sso_user_name | ID Center User Name | testuser |
| status | State | REGISTERED |
| type | OU/Account | OU |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| resource_type optional | **** | OU/Account | OU |
| assignment_id optional | string | Root/Organization Unit/Account ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| status optional | **** | State | REGISTRATION_FAILED |
Responses
| Name | Description | Example |
|---|---|---|
| id | Root/Organization Unit/Account ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| account_assigned_count | Registered Account Count | 3 |
| account_count | Total Account Count | 4 |
| ou_assigned_count | Registered Organization Unit Count | 5 |
| ou_count | Total Organization Unit Count | 10 |
| preventive_guardrail_activated_count | Activated Preventive Guardrail Count | 8 |
| sso_user_name | ID Center User Name | testuser |
| status | State | REGISTERED |
| type | OU/Account | OU |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Guardrail Name | foo-guardrail |
| exclude_unit_id optional | string | Linked(Exclusion) Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| guidance optional | string | Policy Guidance | MANDATORY |
| service_name optional | string | Organization | iam |
| status optional | string | Application Status | ENABLED |
Responses
| Name | Description | Example |
|---|---|---|
| id | Guardrail ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| binding_ous | ||
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| description | Guardrail Description | This is an example guardrail. |
| guidance | Policy Guidance | MANDATORY |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Guardrail Name | foo-guardrail |
| service_name | Organization | iam |
| srn | Guardrail SRN | srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 |
| status | Application Status | |
| type | Guardrail Type | PREVENTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Guardrail Name | foo-guardrail |
| exclude_unit_id optional | string | Linked(Exclusion) Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| guidance optional | string | Policy Guidance | MANDATORY |
| service_name optional | string | Organization | iam |
| status optional | string | Application Status | ENABLED |
Responses
| Name | Description | Example |
|---|---|---|
| id | Guardrail ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| binding_ous | ||
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| description | Guardrail Description | This is an example guardrail. |
| guidance | Policy Guidance | MANDATORY |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Guardrail Name | foo-guardrail |
| service_name | Organization | iam |
| srn | Guardrail SRN | srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 |
| status | Application Status | |
| type | Guardrail Type | PREVENTIVE |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_id required | string | Target ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Guardrail Name | guardrail-example |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| guidance | Policy Guidance | MANDATORY |
| link_types | Link Type | {‘directed’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’}], ‘inherited’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’}]} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Guardrail Name | foo-guardrail |
| service_name | Organization | iam |
| type | Guardrail Type | PREVENTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_id required | string | Target ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Guardrail Name | guardrail-example |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| guidance | Policy Guidance | MANDATORY |
| link_types | Link Type | {‘directed’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’}], ‘inherited’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’}]} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Guardrail Name | foo-guardrail |
| service_name | Organization | iam |
| type | Guardrail Type | PREVENTIVE |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_type required | **** | Target Type | ACCOUNT |
| guardrail_id required | string | Guardrail ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Target Name | ou-test |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| Account Email | score@samsung.com | |
| name | Account Name | score-account |
| parent_unit_id | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | Root or Parent Organization Unit Name | parent-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_type required | **** | Target Type | ACCOUNT |
| guardrail_id required | string | Guardrail ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Target Name | ou-test |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| Account Email | score@samsung.com | |
| name | Account Name | score-account |
| parent_unit_id | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | Root or Parent Organization Unit Name | parent-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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| assignment_id required | string | Root/Organization Unit/Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| resource_type required | string | OU/Account | ACCOUNT |
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| detective_guardrail_status required | string | Detective Guardrail Status | ENABLED |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| guardrail_id required | string | Guardrail ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Guardrail ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| binding_ous | ||
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| description | Guardrail Description | This is an example guardrail. |
| guidance | Policy Guidance | MANDATORY |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Guardrail Name | foo-guardrail |
| service_name | Organization | iam |
| srn | Guardrail SRN | srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 |
| status | Application Status | |
| type | Guardrail Type | PREVENTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| guardrail_id required | string | Guardrail ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| landing_zone_id optional | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Guardrail ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| binding_ous | ||
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| description | Guardrail Description | This is an example guardrail. |
| guidance | Policy Guidance | MANDATORY |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Guardrail Name | foo-guardrail |
| service_name | Organization | iam |
| srn | Guardrail SRN | srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 |
| status | Application Status | |
| type | Guardrail Type | PREVENTIVE |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn | Terms Agreement YN | Y |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| detective_guardrail_status | Detective Guardrail Status | ENABLED |
| identity_center_id | Identity Center ID | 0xnw6g1xh2q5 |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| service_name | Service Name | Cloud Control |
| srn | Landing Zone SRN | srn:dev2::a8a2f3c2659646ecaaf28fc8f783921a:::cloudcontrol:landingzone/f7a1ef0b17e34a37811cc2fa7a6bd50b |
| sso_type | Account Access Configuration | ID_CENTER |
| status | State | ACTIVE |
| version_id | Landing Zone Version | 1.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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn | Terms Agreement YN | Y |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| identity_center_id | Identity Center ID | 0xnw6g1xh2q5 |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| service_name | Service Name | Cloud Control |
| srn | Landing Zone SRN | srn:dev2::a8a2f3c2659646ecaaf28fc8f783921a:::cloudcontrol:landingzone/f7a1ef0b17e34a37811cc2fa7a6bd50b |
| sso_type | Account Access Configuration | ID_CENTER |
| status | State | ACTIVE |
| version_id | Landing Zone Version | 1.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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| assignment_id required | string | Root/Organization Unit/Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn optional | **** | Terms Agreement YN | Y |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| assignment_id required | string | Root/Organization Unit/Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| landing_zone_id required | string | Landing Zone ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn optional | **** | Terms Agreement YN | Y |
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.
| Version | Status | Not Before |
|---|---|---|
| 1.0 | CURRENT | - |
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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| value required | number | 값 | 10 |
| 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 | string | swagger.event.eventPolicyResponse.disableYn.value | N |
| productresourceid required | string | Product 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 | string | swagger.event.eventPolicyResponse.eventOccurTimeZone.value | GMT+9 |
| metricname optional | string | - | |
| objectdisplayname optional | string | 오브젝트 이름 | dm0 |
| objectname optional | string | 오브젝트 이름 | dm0 |
| objecttype optional | string | 개별항목 유형 | SCP |
| podobjectdisplayname optional | string | swagger.event.eventPolicyResponse.podObjectDisplayName.value | dm0 |
| podobjectname optional | string | swagger.event.eventPolicyResponse.podObjectName.value | dm0 |
| metricfunction optional | string | 메트릭 함수 - 유효한 값: [delta] - 이벤트 발생 여부를 판단하기 위해 성능항목의 현재 값을 사용할지, 이전 값과 현재 값의 차이를 사용할지를 지정합니다. - 이전 값과 현재 값의 차이를 사용하고자 할 경우에만 delta로 지정합니다. | delta |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventpolicyid required | integer | Event policy ID to delete - Event Policy ID can be viewed using @[ListEventPolicies]. | 7226 |
| x-resourcetype required | string | Resource 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queryenddt required | string | Query End Date | 2021-10-23T23:59:59.000Z |
| querystartdt required | string | Query Start Date | 2021-10-23T18:00:00.000Z |
| eventstate required | string | Event State | ALL |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| durationSecond | 이벤트 지속 시간 - 단위: 초 | 100 |
| endDt | 종료일시 | 2021-10-23T23:59:59Z |
| eventId | 이벤트 아이디 | |
| eventLevel | 이벤트 레벨 | FATAL |
| eventMessage | 이벤트 메시지 | |
| eventPolicyId | 이벤트 정책 아이디 | 7240 |
| eventState | Event State | ACTIVE |
| 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| companyName | swagger.product.ProjectMemberDto.companyName.value | 삼성SDS |
| createdBy | swagger.product.ProjectMemberDto.createdBy.value | 469 |
| createdByEmail | swagger.product.ProjectMemberDto.createdByEmail.value | soonshin.lee@cloud.com |
| createdByName | swagger.product.ProjectMemberDto.createdByName.value | 이순신 |
| createdDt | swagger.product.ProjectMemberDto.userTimezone.value | 2021-08-06T10:23:41.547Z |
| swagger.product.ProjectMemberDto.userEmail.value | kdhong@cloud.com | |
| lastAccessDt | swagger.product.ProjectMemberDto.lastAccessDt.value | 2022-11-06T10:23:41.547Z |
| modifiedBy | swagger.product.ProjectMemberDto.modifiedBy.value | 469 |
| modifiedByEmail | swagger.product.ProjectMemberDto.modifiedByEmail.value | soonshin.lee@cloud.com |
| modifiedByName | swagger.product.ProjectMemberDto.modifiedByName.value | 이순신 |
| modifiedDt | swagger.product.ProjectMemberDto.modifiedDt.value | 2021-08-06T10:23:41.547Z |
| organizationId | swagger.product.ProjectMemberDto.organizationId.value | |
| positionName | swagger.product.ProjectMemberDto.positionName.value | 프로 |
| userGroupCount | swagger.product.ProjectMemberDto.userGroupCount.value | 10 |
| userId | swagger.product.ProjectMemberDto.userId.value | 1984 |
| userName | swagger.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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| 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, Down | Running |
| 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| addrbookid required | integer | Address book ID - Address book IDs can be obtained from @[ListAddressBooks]. | - |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| productresourceid required | string | Product Resource ID - Product Resource ID can be viewed using @[ListAccountResources]. | c94607c8-6a15-4e13-84f3-99cb77d478e3 |
| metrickey optional | string | Metric Key - Metric Key can be viewed using @[ListMetrics]. | system.cpu.system.pct |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| checkAsg | ||
| createBy | ||
| createById | ||
| eventLevel | 이벤트 레벨 | WARNING |
| eventMessagePrefix | 이벤트 메시지 접두사 | SCP |
| eventOccurTimeZone | swagger.event.eventPolicyResponse.eventOccurTimeZone.value | GMT+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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventpolicyid required | integer | Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies]. | 7226 |
| queryenddt required | string | Query End Date | 2021-10-23T23:59:59.000Z |
| querystartdt required | string | Query Start Date | 2021-10-23T18:00:00.000Z |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| createBy | ||
| createById | ||
| disableObject | swagger.event.eventPolicyResponse.disableObject.value | N |
| disableYn | swagger.event.eventPolicyResponse.disableObject.value | N |
| eventLevel | 이벤트 레벨 | WARNING |
| eventMessagePrefix | 이벤트 메시지 접두사 | SCP |
| eventOccurTimeZone | swagger.event.eventPolicyResponse.eventOccurTimeZone.value | GMT+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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventpolicyid required | integer | Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies]. | 7226 |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| 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 | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| producttypecode optional | string | Product type code - Product type codes can be obtained using @[ListServiceMonitoring]. If not specified, the entire metric list will be retrieved. | VM |
| objecttype optional | string | Object Type - Only available for services that have subtypes, such as when the 'productTypeCode' is 'Kubernetes' or 'Load Balancer'. | node |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| disableObject | swagger.product.MetricInfoDto.disableObject.value | N |
| 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 |
| metricSetKey | swagger.product.MetricInfoDto.metricSetKey.value | system.filesystem |
| metricSetName | 메트릭 세트 이름 | FileSystem |
| metricType | 메트릭 유형 | NUM |
| metricUnit | 메트릭 단위 | bytes |
| objectKeyName | 오브젝트 키 이름 | system.core.iowait.pct |
| objectType | swagger.product.MetricInfoDto.disableObject.value | N |
| objectTypeNameEng | swagger.product.MetricInfoDto.disableObject.value | N |
| objectTypeNameLoc | swagger.product.MetricInfoDto.disableObject.value | N |
| perfTitle | swagger.product.MetricInfoDto.perfTitle.value | File 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| queryenddt required | string | Query End Date | 2021-10-23T23:59:59.000Z |
| querystartdt required | string | Query Start Date | 2021-10-23T18:00:00.000Z |
| eventstate required | string | Event State | ALL |
| productresourceid required | string | Product Resource ID - Product Resource ID can be viewed using @[ListAccountResources]. | INSTANCE-c4Hsd27ttDaLw533X4B6Sp |
| metrickey optional | string | Metric Key - Metric Key can be viewed using @[ListMetrics]. | system.cpu.system.pct |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| durationSecond | 이벤트 지속 시간 - 단위: 초 | 100 |
| endDt | 종료일시 | 2021-10-23T23:59:59Z |
| eventId | 이벤트 아이디 | |
| eventLevel | 이벤트 레벨 | FATAL |
| eventMessage | 이벤트 메시지 | |
| eventPolicyId | 이벤트 정책 아이디 | 7240 |
| eventState | Event State | ACTIVE |
| 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| productcategorycode optional | string | Product type category - If not specified, the entire product type code will be retrieved. | Compute |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
Responses
| Name | Description | Example |
|---|---|---|
| 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventpolicyid required | integer | Event policy ID to modify - Event Policy ID can be viewed using @[ListEventPolicies]. | 7226 |
| value required | number | 값 | 10 |
| 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 | string | swagger.event.eventPolicyResponse.disableYn.value | N |
| notificationrecipients optional | array | 이벤트 알림 수신인 정보 | '{"notificationMethods": [{"eventLevel": "FATAL", "notificationMethod": "", "sendMethod": ["MAIL"]}], "recipientKey": "1347", "recipientType": "USER"}' |
| eventmessageprefix optional | string | 이벤트 메시지 접두사 | SCP |
| eventoccurtimezone optional | string | swagger.event.eventPolicyResponse.eventOccurTimeZone.value | GMT+9 |
| objectdisplayname optional | string | 오브젝트 이름 | cpu0 |
| objectname optional | string | 오브젝트 이름 | cpu0 |
| objecttype optional | string | 개별항목 유형 | cluster |
| podobjectdisplayname optional | string | swagger.event.eventPolicyResponse.podObjectName.value | cpu0 |
| podobjectname optional | string | swagger.event.eventPolicyResponse.podObjectName.value | cpu0 |
| metricfunction optional | string | 메트릭 함수 - 유효한 값: [delta] - 이벤트 발생 여부를 판단하기 위해 성능항목의 현재 값을 사용할지, 이전 값과 현재 값의 차이를 사용할지를 지정합니다. - 이전 값과 현재 값의 차이를 사용하고자 할 경우에만 delta로 지정합니다. | delta |
| x-resourcetype required | string | Resource 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventid required | string | Event ID - Event ID can be viewed using @[ListResourceEvents]. | - |
| page optional | integer | Page Number (default: 0) | 0 |
| size optional | integer | Page Contents Size (default: 10) | 10 |
| sort optional | array | Sorting Field List | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventpolicyid required | integer | Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies]. | 7226 |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| eventid required | string | Event ID - Event ID can be viewed using @[ListResourceEvents]. | - |
| x-resourcetype required | string | Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| checkAsg | ||
| createBy | ||
| createById | ||
| eventLevel | 이벤트 레벨 | WARNING |
| eventMessagePrefix | 이벤트 메시지 접두사 | SCP |
| eventOccurTimeZone | swagger.event.eventPolicyResponse.eventOccurTimeZone.value | GMT+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.
| Version | Status | Not Before |
|---|---|---|
| 1.3 | CURRENT | - |
| 1.2 | SUPPORTED | 20260930 |
| 1.1 | DEPRECATED | 20260531 |
| 1.0 | DEPRECATED | 20260223 |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
Responses
| Name | Description | Example |
|---|---|---|
| Statement | 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’} |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
Responses
| Name | Description | Example |
|---|---|---|
| Statement | 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’} |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
Responses
| Name | Description | Example |
|---|---|---|
| Statement | 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’} |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
Responses
| Name | Description | Example |
|---|---|---|
| Statement | 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’} |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| user_id required | string | Group Member User ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| user_email | Group Member Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_name | Group Member Last Name, First Name | Kim 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| user_id required | string | Group Member User ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| user_email | Group Member Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_name | Group Member Last Name, First Name | Kim 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| user_id required | string | Group Member User ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| user_email | Group Member Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_name | Group Member Last Name, First Name | Kim 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| user_id required | string | Group Member User ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| user_email | Group Member Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_name | Group Member Last Name, First Name | Kim 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| policy_ids required | array | Group Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| policy_ids required | array | Group Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| policy_ids required | array | Group Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| policy_ids required | array | Group Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| policy_ids optional | array | User Policy Bindings | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| policy_ids optional | array | User Policy Bindings | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| policy_ids optional | array | User Policy Bindings | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| policy_ids optional | array | User Policy Bindings | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| policy_ids required | array | Policy ID List to Attach to Role | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| policy_ids required | array | Policy ID List to Attach to Role | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| policy_ids required | array | Policy ID List to Attach to Role | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| policy_ids required | array | Policy ID List to Attach to Role | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Group Name | TestGroup |
| description required | string | Group Description | Descriptions for group |
| policy_ids optional | array | Group Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
| tags optional | array | Group Tag | {'key': 'company', 'value': 'SDS'} |
| user_ids optional | array | Group Member User ID List | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Group Name | TestGroup |
| description required | string | Group Description | Descriptions for group |
| policy_ids optional | array | Group Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
| tags optional | array | Group Tag | {'key': 'company', 'value': 'SDS'} |
| user_ids optional | array | Group Member User ID List | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Group Name | TestGroup |
| description required | string | Group Description | Descriptions for group |
| policy_ids optional | array | Group Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
| tags optional | array | Group Tag | {'key': 'company', 'value': 'SDS'} |
| user_ids optional | array | Group Member User ID List | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Group Name | TestGroup |
| description required | string | Group Description | Descriptions for group |
| policy_ids optional | array | Group Policy ID List | 37f2e31ff86b415698d7e8eeafab445d |
| tags optional | array | Group Tag | {'key': 'company', 'value': 'SDS'} |
| user_ids optional | array | Group Member User ID List | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_name required | string | Policy Name | PolicyName |
| default_version_id optional | string | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_category optional | string | Policy Category | IDENTITY_BASED |
| policy_type optional | string | Policy Type | USER_DEFINED |
| service_type optional | string | Service Type | scp-iam |
| tags optional | array | Policy Tag | {'key': 'foo', 'value': 'bar'} |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_name required | string | Policy Name | PolicyName |
| default_version_id optional | string | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_category optional | string | Policy Category | IDENTITY_BASED |
| policy_type optional | string | Policy Type | USER_DEFINED |
| service_type optional | string | Service Type | scp-iam |
| tags optional | array | Policy Tag | {'key': 'foo', 'value': 'bar'} |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_name required | string | Policy Name | PolicyName |
| default_version_id optional | string | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_category optional | string | Policy Category | IDENTITY_BASED |
| policy_type optional | string | Policy Type | USER_DEFINED |
| service_type optional | string | Service Type | scp-iam |
| tags optional | array | Policy Tag | {'key': 'foo', 'value': 'bar'} |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_name required | string | Policy Name | PolicyName |
| default_version_id optional | string | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_category optional | string | Policy Category | IDENTITY_BASED |
| policy_type optional | string | Policy Type | USER_DEFINED |
| service_type optional | string | Service Type | scp-iam |
| tags optional | array | Policy Tag | {'key': 'foo', 'value': 'bar'} |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_name required | string | Credential Provider Name | IdpTest |
| federation_type required | string | Credential Provider Type | SAML |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| tags optional | array | Tags | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_name required | string | Credential Provider Name | IdpTest |
| federation_type required | string | Credential Provider Type | SAML |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| tags optional | array | Tags | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_name required | string | Credential Provider Name | IdpTest |
| federation_type required | string | Credential Provider Type | SAML |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| tags optional | array | Tags | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_name required | string | Credential Provider Name | IdpTest |
| federation_type required | string | Credential Provider Type | SAML |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| tags optional | array | Tags | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_type required | string | Access Key Type | PERMANENT |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| description optional | string | Description | description |
| duration optional | string | Expiration Duration | P1Y2M10DT2H30M15S |
| parent_access_key_id optional | string | Required Access Key for Creating Temporary Access Key | 92d6eid9e9ae4f868s842910k11573a3 |
| passcode optional | string | Required for Temporary Access Key | 000000 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_type required | string | Access Key Type | PERMANENT |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| description optional | string | Description | description |
| duration optional | string | Expiration Duration | P1Y2M10DT2H30M15S |
| parent_access_key_id optional | string | Required Access Key for Creating Temporary Access Key | 92d6eid9e9ae4f868s842910k11573a3 |
| passcode optional | string | Required for Temporary Access Key | 000000 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_type required | string | Access Key Type | PERMANENT |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| description optional | string | Description | description |
| duration optional | string | Expiration Duration | P1Y2M10DT2H30M15S |
| parent_access_key_id optional | string | Required Access Key for Creating Temporary Access Key | 92d6eid9e9ae4f868s842910k11573a3 |
| passcode optional | string | Required for Temporary Access Key | 000000 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_type required | string | Access Key Type | PERMANENT |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| description optional | string | Description | description |
| duration optional | string | Expiration Duration | P1Y2M10DT2H30M15S |
| parent_access_key_id optional | string | Required Access Key for Creating Temporary Access Key | 92d6eid9e9ae4f868s842910k11573a3 |
| passcode optional | string | Required for Temporary Access Key | 000000 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| user_name required | string | User Name | - |
| temporary_password required | boolean | Temporary | - |
| password required | string | Password | - |
| description optional | string | User Description | - |
| group_ids optional | array | Group IDs | - |
| policy_ids optional | array | Policy IDs Field | - |
| tags optional | array | User Tag | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| user_name required | string | User Name | - |
| temporary_password required | boolean | Temporary | - |
| password required | string | Password | - |
| description optional | string | User Description | - |
| group_ids optional | array | Group IDs | - |
| policy_ids optional | array | Policy IDs Field | - |
| tags optional | array | User Tag | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| user_name required | string | User Name | - |
| temporary_password required | boolean | Temporary | - |
| password required | string | Password | - |
| description optional | string | User Description | - |
| group_ids optional | array | Group IDs | - |
| policy_ids optional | array | Policy IDs Field | - |
| tags optional | array | User Tag | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| user_name required | string | User Name | - |
| temporary_password required | boolean | Temporary | - |
| password required | string | Password | - |
| description optional | string | User Description | - |
| group_ids optional | array | Group IDs | - |
| policy_ids optional | array | Policy IDs Field | - |
| tags optional | array | User Tag | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_ids required | array | Policy ID List to Attach to Role | 37f2e31ff86b415698d7e8eeafab445d |
| name required | string | Role Name | - |
| account_id optional | string | Account ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role Maximum Session Duration (seconds) | 3600 |
| principals optional | array | Trust Policy Principal List | '{"type": "", "value": ""}' |
| role_type optional | string | Role Type | - |
| tags optional | array | Role Tag | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_ids required | array | Policy ID List to Attach to Role | 37f2e31ff86b415698d7e8eeafab445d |
| name required | string | Role Name | - |
| account_id optional | string | Account ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role Maximum Session Duration (seconds) | 3600 |
| principals optional | array | Trust Policy Principal List | '{"type": "", "value": ""}' |
| tags optional | array | Role Tag | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_ids required | array | Policy ID List to Attach to Role | 37f2e31ff86b415698d7e8eeafab445d |
| name required | string | Role Name | - |
| account_id optional | string | Account ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role Maximum Session Duration (seconds) | 3600 |
| principals optional | array | Trust Policy Principal List | '{"type": "", "value": ""}' |
| tags optional | array | Role Tag | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_ids required | array | Policy ID List to Attach to Role | 37f2e31ff86b415698d7e8eeafab445d |
| name required | string | Role Name | - |
| account_id optional | string | Account ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role Maximum Session Duration (seconds) | 3600 |
| principals optional | array | Trust Policy Principal List | '{"type": "", "value": ""}' |
| tags optional | array | Role Tag | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id optional | string | Account ID | - |
| role_ids optional | array | Role ID List | - |
| role_names optional | array | Role 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id optional | string | Account ID | - |
| role_ids optional | array | Role ID List | - |
| role_names optional | array | Role 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id optional | string | Account ID | - |
| role_ids optional | array | Role ID List | - |
| role_names optional | array | Role 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id optional | string | Account ID | - |
| role_ids optional | array | Role ID List | - |
| role_names optional | array | Role 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| user_ids optional | array | User 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| user_ids optional | array | User 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| user_ids optional | array | User 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| user_ids optional | array | User 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
3.1.15.2 - 1.2
scpcli iam role delete
--role_id <value>
Description
Delete role
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
3.1.16.2 - 1.2
scpcli iam policy delete
--policy_id <value>
Description
Delete the policy
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
3.1.17.2 - 1.2
scpcli iam resource policy delete
--srn <value>
Description
Delete the resource based policy
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | - |
| user_id required | string | User 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | - |
| user_id required | string | User 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | - |
| user_id required | string | User 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | - |
| user_id required | string | User 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| policy_ids required | array | Policy 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| policy_ids required | array | Policy 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| policy_ids required | array | Policy 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| policy_ids required | array | Policy 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID Attached to Role | - |
| role_id required | string | Role 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID Attached to Role | - |
| role_id required | string | Role 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID Attached to Role | - |
| role_id required | string | Role 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID Attached to Role | - |
| role_id required | string | Role 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_DEFINED |
3.1.21.2 - 1.2
scpcli iam group show
--group_id <value>
Description
Get a Group
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| identity_id optional | string | Identity ID | f39c460fade34fecb05ede8f904b24b7 |
| identity_type optional | string | Identity Type | GROUP |
| name optional | string | Name | TestGroup |
Responses
| Name | Description | Example |
|---|---|---|
| count | count | 20 |
| groups | Group | [{‘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’}] |
| page | page | 0 |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| roles | Role | [{‘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’}] |
| size | size | 20 |
| sort | sort | [‘created_at:asc’] |
| users | User | [{‘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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| identity_id optional | string | Identity ID | f39c460fade34fecb05ede8f904b24b7 |
| identity_type optional | string | Identity Type | GROUP |
| name optional | string | Name | TestGroup |
Responses
| Name | Description | Example |
|---|---|---|
| count | count | 20 |
| groups | Group | [{‘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’}] |
| page | page | 0 |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| roles | Role | [{‘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’}] |
| size | size | 20 |
| sort | sort | [‘created_at:asc’] |
| users | User | [{‘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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| identity_id optional | string | Identity ID | f39c460fade34fecb05ede8f904b24b7 |
| identity_type optional | string | Identity Type | GROUP |
| name optional | string | Name | TestGroup |
Responses
| Name | Description | Example |
|---|---|---|
| count | count | 20 |
| groups | Group | [{‘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’}] |
| page | page | 0 |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| roles | Role | [{‘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’}] |
| size | size | 20 |
| sort | sort | [‘created_at:asc’] |
| users | User | [{‘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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| identity_id optional | string | Identity ID | f39c460fade34fecb05ede8f904b24b7 |
| identity_type optional | string | Identity Type | GROUP |
| name optional | string | Name | TestGroup |
Responses
| Name | Description | Example |
|---|---|---|
| count | count | 20 |
| groups | Group | [{‘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’}] |
| page | page | 0 |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| roles | Role | [{‘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’}] |
| size | size | 20 |
| sort | sort | [‘created_at:asc’] |
| users | User | [{‘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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Responses
| Name | Description | Example |
|---|---|---|
| region | Region | kr-west1 |
| service_name | Service Name | scp-iam |
| service_type | Service Type | scp-iam |
| url | URL | https://iam.dev2.samsungsdscloud.com |
3.1.24.2 - 1.2
scpcli iam endpoint list
Description
Get endpoint list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Responses
| Name | Description | Example |
|---|---|---|
| region | Region | kr-west1 |
| service_name | Service Name | scp-iam |
| service_type | Service Type | scp-iam |
| url | URL | https://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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Responses
| Name | Description | Example |
|---|---|---|
| region | Region | kr-west1 |
| service_name | Service Name | scp-iam |
| service_type | Service Type | scp-iam |
| url | URL | https://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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Responses
| Name | Description | Example |
|---|---|---|
| region | Region | kr-west1 |
| service_name | Service Name | scp-iam |
| service_type | Service Type | scp-iam |
| url | URL | https://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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
3.1.25.2 - 1.2
scpcli iam iam user show
--user_id <value>
--account_id <value>
Description
Get IAM users
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Creator Last Name, First Name | test1 |
| creator_email optional | string | Creator Email | test@test.com |
| modifier_name optional | string | Modifier Last Name, First Name | test1 |
| modifier_email optional | string | Modifier Email | test@test.com |
| exclude_group_id optional | string | Group ID to Exclude | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | User ID to Exclude | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Creator Last Name, First Name | test1 |
| creator_email optional | string | Creator Email | test@test.com |
| modifier_name optional | string | Modifier Last Name, First Name | test1 |
| modifier_email optional | string | Modifier Email | test@test.com |
| exclude_group_id optional | string | Group ID to Exclude | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | User ID to Exclude | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Creator Last Name, First Name | test1 |
| creator_email optional | string | Creator Email | test@test.com |
| modifier_name optional | string | Modifier Last Name, First Name | test1 |
| modifier_email optional | string | Modifier Email | test@test.com |
| exclude_group_id optional | string | Group ID to Exclude | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | User ID to Exclude | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Creator Last Name, First Name | test1 |
| creator_email optional | string | Creator Email | test@test.com |
| modifier_name optional | string | Modifier Last Name, First Name | test1 |
| modifier_email optional | string | Modifier Email | test@test.com |
| exclude_group_id optional | string | Group ID to Exclude | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | User ID to Exclude | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
3.1.27 - Get role
3.1.27.1 - 1.3
scpcli iam role show
--role_id <value>
Description
Get role
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role Type |
3.1.27.2 - 1.2
scpcli iam role show
--role_id <value>
Description
Get role
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Role Name | - |
| role_type optional | string | Role Type | - |
| account_id optional | string | Account ID | - |
| exclude_policy_id optional | string | Policy Exception | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Role Name | - |
| role_type optional | string | Role Type | - |
| account_id optional | string | Account ID | - |
| exclude_policy_id optional | string | Policy Exception | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Role Name | - |
| role_type optional | string | Role Type | - |
| account_id optional | string | Account ID | - |
| exclude_policy_id optional | string | Policy Exception | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Role Name | - |
| role_type optional | string | Role Type | - |
| account_id optional | string | Account ID | - |
| exclude_policy_id optional | string | Policy Exception | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID Attached to Role | - |
| policy_name optional | string | Policy Name Attached to Role | - |
| policy_type optional | string | Policy Type List Attached to Role | ['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID Attached to Role | - |
| policy_name optional | string | Policy Name Attached to Role | - |
| policy_type optional | string | Policy Type List Attached to Role | ['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID Attached to Role | - |
| policy_name optional | string | Policy Name Attached to Role | - |
| policy_type optional | string | Policy Type List Attached to Role | ['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID Attached to Role | - |
| policy_name optional | string | Policy Name Attached to Role | - |
| policy_type optional | string | Policy Type List Attached to Role | ['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | Credential Provider ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_data | Metadata Content | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | Credential Provider ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_data | Metadata Content | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | Credential Provider ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_data | Metadata Content | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | Credential Provider ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| acs_url | ACS URL | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| idp_cert_end | Validity Period | |
| idp_file_data | Metadata Content | |
| idp_file_name | Metadata File Name | |
| idp_file_size | Metadata File Size | |
| idp_issuer_url | Issuer URL | |
| idp_sso_url | SSO Service Location | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_account_id required | string | Service Account ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| password | Service Account’s Password | |
| service | Service 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_account_id required | string | Service Account ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| password | Service Account’s Password | |
| service | Service 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_account_id required | string | Service Account ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| password | Service Account’s Password | |
| service | Service 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_account_id required | string | Service Account ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| password | Service Account’s Password | |
| service | Service 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID | - |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type List | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID | - |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type List | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID | - |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type List | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID | - |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type List | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_name optional | string | Group Member Last Name, First Name | Kim Samsung |
| user_email optional | string | Group Member Email | samsung.kim@samsung.com |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_created_at | Created At | 2024-05-17T00:23:17Z |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_last_login_at | Group Member Last Login At | 2024-05-17T00:23:17Z |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| group_names | Group Names | [‘TestGroup’, ‘SampleGroup’] |
| user_created_at | Created At | 2024-05-17T00:23:17Z |
| user_email | Group Member Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_last_login_at | Group Member Last Login At | 2024-05-17T00:23:17Z |
| user_name | Group Member Last Name, First Name | Kim 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_name optional | string | Group Member Last Name, First Name | Kim Samsung |
| user_email optional | string | Group Member Email | samsung.kim@samsung.com |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_created_at | Created At | 2024-05-17T00:23:17Z |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_last_login_at | Group Member Last Login At | 2024-05-17T00:23:17Z |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| group_names | Group Names | [‘TestGroup’, ‘SampleGroup’] |
| user_created_at | Created At | 2024-05-17T00:23:17Z |
| user_email | Group Member Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_last_login_at | Group Member Last Login At | 2024-05-17T00:23:17Z |
| user_name | Group Member Last Name, First Name | Kim 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_name optional | string | Group Member Last Name, First Name | Kim Samsung |
| user_email optional | string | Group Member Email | samsung.kim@samsung.com |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_created_at | Created At | 2024-05-17T00:23:17Z |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_last_login_at | Group Member Last Login At | 2024-05-17T00:23:17Z |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| group_names | Group Names | [‘TestGroup’, ‘SampleGroup’] |
| user_created_at | Created At | 2024-05-17T00:23:17Z |
| user_email | Group Member Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_last_login_at | Group Member Last Login At | 2024-05-17T00:23:17Z |
| user_name | Group Member Last Name, First Name | Kim 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_name optional | string | Group Member Last Name, First Name | Kim Samsung |
| user_email optional | string | Group Member Email | samsung.kim@samsung.com |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_created_at | Created At | 2024-05-17T00:23:17Z |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_last_login_at | Group Member Last Login At | 2024-05-17T00:23:17Z |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| group_names | Group Names | [‘TestGroup’, ‘SampleGroup’] |
| user_created_at | Created At | 2024-05-17T00:23:17Z |
| user_email | Group Member Email | samsung.kim@samsung.com |
| user_id | User ID | f39c460fade34fecb05ede8f904b24b7 |
| user_last_login_at | Group Member Last Login At | 2024-05-17T00:23:17Z |
| user_name | Group Member Last Name, First Name | Kim 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| access_key_type optional | string | Access Key Type | PERMANENT |
| parent_access_key_id optional | string | Parent Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| access_key_type optional | string | Access Key Type | PERMANENT |
| parent_access_key_id optional | string | Parent Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| access_key_type optional | string | Access Key Type | PERMANENT |
| parent_access_key_id optional | string | Parent Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| access_key_type optional | string | Access Key Type | PERMANENT |
| parent_access_key_id optional | string | Parent Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 6558fc9df5b54c8a985465bdf637e097 |
| access_key | Access Key | b754b12b39da4ce29a40c5e324650bd0 |
| access_key_type | Access Key Type | PERMANENT |
| account_id | Account Id | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | description |
| expiration_timestamp | Access Key Expiration Timestamp | 9999-12-31T23:59:59Z |
| is_enabled | Activation Status | true |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| parent_access_key_id | Parent Access Key ID Used for Temporary Access Key Creation | 92d6eid9e9ae4f868s842910k11573a3 |
| secret_key | Secret Key | c4150149-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Group Name | TestGroup |
| types optional | string | Group Types | USER_DEFINED,DEFAULT |
| ids optional | string | Group ID List | 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 |
| has_member optional | string | Group Member Existence | false |
| has_role optional | string | Group Role Existence | false |
| is_completed optional | string | Group Completion Status | false |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
| modifier_name optional | string | Modifier Last Name, First Name | Kim Samsung |
| modifier_email optional | string | Modifier Email | samsung.kim@samsung.com |
| exclude_user_id optional | string | User ID to Exclude | f39c460fade34fecb05ede8f904b24b7 |
| exclude_policy_id optional | string | Policy ID to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Group Name | TestGroup |
| types optional | string | Group Types | USER_DEFINED,DEFAULT |
| ids optional | string | Group ID List | 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 |
| has_member optional | string | Group Member Existence | false |
| has_role optional | string | Group Role Existence | false |
| is_completed optional | string | Group Completion Status | false |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
| modifier_name optional | string | Modifier Last Name, First Name | Kim Samsung |
| modifier_email optional | string | Modifier Email | samsung.kim@samsung.com |
| exclude_user_id optional | string | User ID to Exclude | f39c460fade34fecb05ede8f904b24b7 |
| exclude_policy_id optional | string | Policy ID to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Group Name | TestGroup |
| types optional | string | Group Types | USER_DEFINED,DEFAULT |
| ids optional | string | Group ID List | 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 |
| has_member optional | string | Group Member Existence | false |
| has_role optional | string | Group Role Existence | false |
| is_completed optional | string | Group Completion Status | false |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
| modifier_name optional | string | Modifier Last Name, First Name | Kim Samsung |
| modifier_email optional | string | Modifier Email | samsung.kim@samsung.com |
| exclude_user_id optional | string | User ID to Exclude | f39c460fade34fecb05ede8f904b24b7 |
| exclude_policy_id optional | string | Policy ID to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Group Name | TestGroup |
| types optional | string | Group Types | USER_DEFINED,DEFAULT |
| ids optional | string | Group ID List | 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 |
| has_member optional | string | Group Member Existence | false |
| has_role optional | string | Group Role Existence | false |
| is_completed optional | string | Group Completion Status | false |
| creator_name optional | string | Creator Last Name, First Name | Kim Samsung |
| creator_email optional | string | Creator Email | samsung.kim@samsung.com |
| modifier_name optional | string | Modifier Last Name, First Name | Kim Samsung |
| modifier_email optional | string | Modifier Email | samsung.kim@samsung.com |
| exclude_user_id optional | string | User ID to Exclude | f39c460fade34fecb05ede8f904b24b7 |
| exclude_policy_id optional | string | Policy ID to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| description | Group Description | Descriptions for group |
| domain_name | Domain Name | scp |
| members | Group Member List | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| name | Group Name | TestGroup |
| policies | Policy | [] |
| resource_type | Resource Name | group |
| roles | Role Information | [] |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda |
| type | Group Types | USER_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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | User Email | - |
| nation_id optional | string | Nation ID | - |
| phone_number optional | string | User Phone Number | - |
| user_name optional | string | User Name | - |
| exclude_group_id optional | string | Exception Target Group | - |
| exclude_policy_id optional | string | Exception Target Policy | - |
| type optional | string | User Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | Account ID | |
| company_name | Company Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | Email Authentication Status | |
| first_name | User Name | |
| groups | Group Names | |
| last_login_at | Last Login | |
| last_name | User Last Name | |
| last_password_update_at | Last Password Update Time | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | Password Reuse Count | |
| phone_authenticated | Phone Authentication Status | |
| policies | User Policies | [] |
| state | Status | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | User Email | - |
| nation_id optional | string | Nation ID | - |
| phone_number optional | string | User Phone Number | - |
| user_name optional | string | User Name | - |
| exclude_group_id optional | string | Exception Target Group | - |
| exclude_policy_id optional | string | Exception Target Policy | - |
| type optional | string | User Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | Account ID | |
| company_name | Company Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | Email Authentication Status | |
| first_name | User Name | |
| groups | Group Names | |
| last_login_at | Last Login | |
| last_name | User Last Name | |
| last_password_update_at | Last Password Update Time | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | Password Reuse Count | |
| phone_authenticated | Phone Authentication Status | |
| policies | User Policies | [] |
| state | Status | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | User Email | - |
| nation_id optional | string | Nation ID | - |
| phone_number optional | string | User Phone Number | - |
| user_name optional | string | User Name | - |
| exclude_group_id optional | string | Exception Target Group | - |
| exclude_policy_id optional | string | Exception Target Policy | - |
| type optional | string | User Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | Account ID | |
| company_name | Company Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | Email Authentication Status | |
| first_name | User Name | |
| groups | Group Names | |
| last_login_at | Last Login | |
| last_name | User Last Name | |
| last_password_update_at | Last Password Update Time | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | Password Reuse Count | |
| phone_authenticated | Phone Authentication Status | |
| policies | User Policies | [] |
| state | Status | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Account ID Field | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| login_id optional | string | Login ID | - |
| email optional | string | User Email | - |
| nation_id optional | string | Nation ID | - |
| phone_number optional | string | User Phone Number | - |
| user_name optional | string | User Name | - |
| exclude_group_id optional | string | Exception Target Group | - |
| exclude_policy_id optional | string | Exception Target Policy | - |
| type optional | string | User Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | |
| account_id | Account ID | |
| company_name | Company Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | User Description | |
| dst_offset | DST Offset | |
| User Email | ||
| email_authenticated | Email Authentication Status | |
| first_name | User Name | |
| groups | Group Names | |
| last_login_at | Last Login | |
| last_name | User Last Name | |
| last_password_update_at | Last Password Update Time | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name | |
| password_reuse_count | Password Reuse Count | |
| phone_authenticated | Phone Authentication Status | |
| policies | User Policies | [] |
| state | Status | |
| timezone | Timezone ID | |
| type | Type | |
| tz_id | Timezone ID | |
| user_name | User Name | |
| utc_offset | UTC 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| federation_type optional | string | Credential Provider Type | - |
| saml_provider_name optional | string | Credential Provider Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| federation_type optional | string | Credential Provider Type | - |
| saml_provider_name optional | string | Credential Provider Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| federation_type optional | string | Credential Provider Type | - |
| saml_provider_name optional | string | Credential Provider Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| federation_type optional | string | Credential Provider Type | - |
| saml_provider_name optional | string | Credential Provider Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator | |
| description | Credential Provider Description | |
| federation_type | Credential Provider Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier | |
| saml_provider_name | Credential 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Service Account Name | - |
| service optional | string | Service Account's Service | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| service | Service 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Service Account Name | - |
| service optional | string | Service Account's Service | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| service | Service 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Service Account Name | - |
| service optional | string | Service Account's Service | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| service | Service 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name optional | string | Service Account Name | - |
| service optional | string | Service Account's Service | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Account ID | |
| name | Service Account Name | |
| service | Service 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| name required | string | Group Name | TestGroup |
| description required | string | Group Description | Descriptions 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| name required | string | Group Name | TestGroup |
| description required | string | Group Description | Descriptions 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| name required | string | Group Name | TestGroup |
| description required | string | Group Description | Descriptions 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| name required | string | Group Name | TestGroup |
| description required | string | Group Description | Descriptions 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Creator Last Name, First Name | test1 |
| creator_email optional | string | Creator Email | test@test.com |
| modifier_name optional | string | Modifier Last Name, First Name | test1 |
| modifier_email optional | string | Modifier Email | test@test.com |
| exclude_group_id optional | string | Group ID to Exclude | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | User ID to Exclude | - |
| excluded_policy_ids optional | array | Policy IDs to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Creator Last Name, First Name | test1 |
| creator_email optional | string | Creator Email | test@test.com |
| modifier_name optional | string | Modifier Last Name, First Name | test1 |
| modifier_email optional | string | Modifier Email | test@test.com |
| exclude_group_id optional | string | Group ID to Exclude | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | User ID to Exclude | - |
| excluded_policy_ids optional | array | Policy IDs to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Creator Last Name, First Name | test1 |
| creator_email optional | string | Creator Email | test@test.com |
| modifier_name optional | string | Modifier Last Name, First Name | test1 |
| modifier_email optional | string | Modifier Email | test@test.com |
| exclude_group_id optional | string | Group ID to Exclude | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | User ID to Exclude | - |
| excluded_policy_ids optional | array | Policy IDs to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | SYSTEM_MANAGED |
| service_type optional | string | Service Type | scp-iam |
| creator_name optional | string | Creator Last Name, First Name | test1 |
| creator_email optional | string | Creator Email | test@test.com |
| modifier_name optional | string | Modifier Last Name, First Name | test1 |
| modifier_email optional | string | Modifier Email | test@test.com |
| exclude_group_id optional | string | Group ID to Exclude | a946662dc4314dac93da413a32457459 |
| exclude_user_id optional | string | User ID to Exclude | - |
| excluded_policy_ids optional | array | Policy IDs to Exclude | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | ef50cdc207f05f6fb8f20219f229ed1f |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | ef50cdc207f05f6fb8f20219f229ed1f |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | ef50cdc207f05f6fb8f20219f229ed1f |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | ef50cdc207f05f6fb8f20219f229ed1f |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
3.1.43 - Remove policies
3.1.43.1 - 1.3
scpcli iam policy bulk delete
[--ids <value>]
Description
Remove policies
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | ID List | 37f2e31ff86b415698d7e8eeafab445d |
3.1.43.2 - 1.2
scpcli iam policy bulk delete
[--ids <value>]
Description
Remove policies
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | ID List | 37f2e31ff86b415698d7e8eeafab445d |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | ID List | 37f2e31ff86b415698d7e8eeafab445d |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | ID List | 37f2e31ff86b415698d7e8eeafab445d |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Credential Provider ID List | - |
3.1.45.2 - 1.2
scpcli iam saml provider bulk delete
[--ids <value>]
Description
Remove saml providers
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Credential 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Credential 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Credential 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
3.1.46.2 - 1.2
scpcli iam access-key delete
--access_key_id <value>
Description
Remove the access key
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Access Key ID List | - |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| with_count optional | string | with count | true |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Access Key ID List | - |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| with_count optional | string | with count | true |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Access Key ID List | - |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| with_count optional | string | with count | true |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Access Key ID List | - |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| with_count optional | string | with count | true |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
3.1.48.2 - 1.2
scpcli iam group delete
--group_id <value>
Description
Remove the Group
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| locale optional | string | Locale | - |
| method optional | string | OTP Method (EMAIL or PHONE) | - |
Responses
| Name | Description | Example |
|---|
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| locale optional | string | Locale | - |
| method optional | string | OTP Method (EMAIL or PHONE) | - |
Responses
| Name | Description | Example |
|---|
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| locale optional | string | Locale | - |
| method optional | string | OTP Method (EMAIL or PHONE) | - |
Responses
| Name | Description | Example |
|---|
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| locale optional | string | Locale | - |
| method optional | string | OTP Method (EMAIL or PHONE) | - |
Responses
| Name | Description | Example |
|---|
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sid required | string | Statement ID | Statement1 |
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| effect required | string | Effect | Allow |
| action optional | array | Action | virtualserver:ShowVirtualServer |
| condition optional | object | Condition | {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} |
| notaction optional | array | NotAction | - |
| principal optional | string | Principal | * |
| resource optional | array | Resource | srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666 |
| sid optional | string | Statement Id | Statement1 |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
| is_enabled optional | boolean | Activation Status | true |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
| is_enabled optional | boolean | Activation Status | true |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
| is_enabled optional | boolean | Activation Status | true |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| access_key_id required | string | Access Key ID | f39c460fade34fecb05ede8f904b24b7 |
| is_enabled optional | boolean | Activation Status | true |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_id required | string | Role ID | - |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| default_version_id optional | string | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_name optional | string | Policy Name | Policy1 |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| default_version_id optional | string | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_name optional | string | Policy Name | Policy1 |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| default_version_id optional | string | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_name optional | string | Policy Name | Policy1 |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| default_version_id optional | string | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description optional | string | Description | Descriptions for policy |
| policy_name optional | string | Policy Name | Policy1 |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_id optional | string | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| policy_version_name optional | string | Policy Version Name | PolicyVersion-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | a946662dc4314dac93da413a32457459 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_id optional | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_name optional | string | Policy Name | ViewerAccess |
| policy_type optional | string | Policy Type | ['SYSTEM_MANAGED', 'USER_DEFINED'] |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| account_id | Account Id | e99c73a8690d4ae39ae75e38a26f2b99 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_email | Creator Email | samsung.kim@samsung.com |
| creator_name | Creator Last Name, First Name | Kim Samsung |
| default_version_id | Default Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| description | Description | Descriptions for policy |
| domain_name | Domain Name | scp |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_email | Modifier Email | samsung.kim@samsung.com |
| modifier_name | Modifier Last Name, First Name | Kim Samsung |
| policy_category | Policy Category | IDENTITY_BASED |
| policy_name | Policy Name | PolicyName |
| policy_type | Policy Type | USER_DEFINED |
| policy_versions | Policy Versions | |
| resource_type | Resource Type | policy |
| service_name | Service Name | Identity Access Management |
| service_type | Service Type | iam |
| srn | Samsung Resource Name | srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d |
| state | Policy State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-1 |
3.1.57.2 - 1.2
scpcli iam policy show
--policy_id <value>
Description
Show the policy
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy Document | |
| policy_id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| policy_version_name | Policy Version Name | PolicyVersion-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | Samsung Resource Name | c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy Version Id | c1b1fc611eb34eccbccfb563f77395ee |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| policy_document | Policy 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
| password_reuse_count required | integer | Password Reuse Count | - |
| description optional | string | User 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
| password_reuse_count required | integer | Password Reuse Count | - |
| description optional | string | User 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
| password_reuse_count required | integer | Password Reuse Count | - |
| description optional | string | User 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
| password_reuse_count required | integer | Password Reuse Count | - |
| description optional | string | User 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
| password required | string | Password | - |
| temporary_password optional | boolean | Temporary | - |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
| password required | string | Password | - |
| temporary_password optional | boolean | Temporary | - |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
| password required | string | Password | - |
| temporary_password optional | boolean | Temporary | - |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User ID | - |
| account_id required | string | Account ID Field | - |
| password required | string | Password | - |
| temporary_password optional | boolean | Temporary | - |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | Credential Provider ID | - |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| saml_provider_name optional | string | Credential Provider Name | IdpTest |
| tags optional | array | Tags | {'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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | Credential Provider ID | - |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| saml_provider_name optional | string | Credential Provider Name | IdpTest |
| tags optional | array | Tags | {'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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | Credential Provider ID | - |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| saml_provider_name optional | string | Credential Provider Name | IdpTest |
| tags optional | array | Tags | {'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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_provider_id required | string | Credential Provider ID | - |
| description optional | string | Credential Provider Description | SAML provider Description |
| file optional | string | Metadata File | keycloak-idp-saml.xml |
| saml_provider_name optional | string | Credential Provider Name | IdpTest |
| tags optional | array | Tags | {'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.
| Version | Status | Not Before |
|---|---|---|
| 1.3 | CURRENT | - |
| 1.2 | SUPPORTED | 20260930 |
| 1.1 | DEPRECATED | 20260531 |
| 1.0 | DEPRECATED | 20260223 |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-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
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| permission_set_id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_id | Principal ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_type | Principal Type | USER |
| target_account_id | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-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
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| permission_set_id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_id | Principal ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_type | Principal Type | USER |
| target_account_id | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-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
| Name | Description | Example |
|---|---|---|
| account_assignment_id | Assignment ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| permission_set_id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_id | Principal ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_type | Principal Type | USER |
| role_srn | Permission Set Description | Permissions for administrators |
| target_account_id | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-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
| Name | Description | Example |
|---|---|---|
| account_assignment_id | Assignment ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| permission_set_id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_id | Principal ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_type | Principal Type | USER |
| role_srn | Permission Set Description | Permissions for administrators |
| target_account_id | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Group Name | Admin_Group |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| user_uuids optional | array | List of User IDs to be added to the group | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Group Name | Admin_Group |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| user_uuids optional | array | List of User IDs to be added to the group | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Group Name | Admin_Group |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| user_uuids optional | array | List of User IDs to be added to the group | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Group Name | Admin_Group |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| user_uuids optional | array | List of User IDs to be added to the group | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Instance Name | My Instance |
| description optional | string | Instance Description | My Instance Description |
| identity_store_type optional | string | Identity Store Type | - |
| bind_credential optional | string | Bind Password | password |
| bind_dn optional | string | Bind DN | CN=Administrator,CN=Users,DC=test,DC=add |
| connection_url optional | string | LDAP Server URL | ldaps://test.subdomain.company.com:123 |
| rdn_ldap_attribute optional | string | RDN LDAP Attribute | cn |
| user_object_classes optional | string | User Object Classes | person, organizationalPerson, user |
| username_ldap_attribute optional | string | Username LDAP Attribute | sAMAccountName |
| users_dn optional | string | Users DN | OU=Employees,OU=Accounts,DC=sub,DC=org |
Responses
| Name | Description | Example |
|---|---|---|
| id | Instance ID | ssoins-12345 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delegated_account_id | Delegated Account ID | acc-2353 |
| delegated_at | Delegation Date | 2023-10-15 14:30:00 |
| delegated_by | Delegated By | sef2w3c8c29a449dbfa8681f8f1d78e2 |
| description | Instance Description | My Instance Description |
| identity_store_config | Identity 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_id | Identity Store ID | d-12345 |
| identity_store_type | Identity Store Type | |
| last_sync_at | Last Sync Date | 2025-08-06 10:30:00 |
| last_sync_status | Last Sync Status | [‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’] |
| master_account_id | Master Account ID | acc-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Instance Name | My Instance |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | Instance SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| sso_start_url | SSO Start URL | https://login.e.samsungsdscloud.com/d-12345 |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Instance Name | My Instance |
| description optional | string | Instance Description | My Instance Description |
| identity_store_type optional | string | Identity Store Type | - |
| bind_credential optional | string | Bind Password | password |
| bind_dn optional | string | Bind DN | CN=Administrator,CN=Users,DC=test,DC=add |
| connection_url optional | string | LDAP Server URL | ldaps://test.subdomain.company.com:123 |
| rdn_ldap_attribute optional | string | RDN LDAP Attribute | cn |
| user_object_classes optional | string | User Object Classes | person, organizationalPerson, user |
| username_ldap_attribute optional | string | Username LDAP Attribute | sAMAccountName |
| users_dn optional | string | Users DN | OU=Employees,OU=Accounts,DC=sub,DC=org |
Responses
| Name | Description | Example |
|---|---|---|
| id | Instance ID | ssoins-12345 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delegated_account_id | Delegated Account ID | acc-2353 |
| delegated_at | Delegation Date | 2023-10-15 14:30:00 |
| delegated_by | Delegated By | sef2w3c8c29a449dbfa8681f8f1d78e2 |
| description | Instance Description | My Instance Description |
| identity_store_config | Identity 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_id | Identity Store ID | d-12345 |
| identity_store_type | Identity Store Type | |
| last_sync_at | Last Sync Date | 2025-08-06 10:30:00 |
| last_sync_status | Last Sync Status | [‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’] |
| master_account_id | Master Account ID | acc-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Instance Name | My Instance |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | Instance SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| sso_start_url | SSO Start URL | https://login.e.samsungsdscloud.com/d-12345 |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Instance Name | My Instance |
| description optional | string | Instance Description | My Instance Description |
| identity_store_type optional | string | Identity Store Type | - |
| bind_credential optional | string | Bind Password | password |
| bind_dn optional | string | Bind DN | CN=Administrator,CN=Users,DC=test,DC=add |
| connection_url optional | string | LDAP Server URL | ldaps://test.subdomain.company.com:123 |
| rdn_ldap_attribute optional | string | RDN LDAP Attribute | cn |
| user_object_classes optional | string | User Object Classes | person, organizationalPerson, user |
| username_ldap_attribute optional | string | Username LDAP Attribute | sAMAccountName |
| users_dn optional | string | Users DN | OU=Employees,OU=Accounts,DC=sub,DC=org |
Responses
| Name | Description | Example |
|---|---|---|
| id | Instance ID | ssoins-12345 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delegated_account_id | Delegated Account ID | acc-2353 |
| delegated_at | Delegation Date | 2023-10-15 14:30:00 |
| delegated_by | Delegated By | sef2w3c8c29a449dbfa8681f8f1d78e2 |
| description | Instance Description | My Instance Description |
| identity_store_config | Identity 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_id | Identity Store ID | d-12345 |
| identity_store_type | Identity Store Type | |
| last_sync_at | Last Sync Date | 2025-08-06 10:30:00 |
| last_sync_status | Last Sync Status | [‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’] |
| master_account_id | Master Account ID | acc-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Instance Name | My Instance |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | Instance SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| sso_start_url | SSO Start URL | https://login.e.samsungsdscloud.com/d-12345 |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| session_duration required | integer | Maximum Session Duration | 3600 |
| name required | string | Instance Name | My Instance |
| instance_id required | string | Instance ID | ssoins-12345 |
| custom_policies optional | array | Customer Managed Policy | - |
| description optional | string | Instance Description | My Instance Description |
| inline_policies optional | array | Inline Policy | - |
| managed_policies optional | array | Managed Policy | '{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| custom_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| session_duration required | integer | Maximum Session Duration | 3600 |
| name required | string | Instance Name | My Instance |
| instance_id required | string | Instance ID | ssoins-12345 |
| custom_policies optional | array | Customer Managed Policy | - |
| description optional | string | Instance Description | My Instance Description |
| inline_policies optional | array | Inline Policy | - |
| managed_policies optional | array | Managed Policy | '{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| custom_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| session_duration required | integer | Maximum Session Duration | 3600 |
| name required | string | Instance Name | My Instance |
| instance_id required | string | Instance ID | ssoins-12345 |
| customer_policies optional | array | Customer Managed Policy | - |
| description optional | string | Instance Description | My Instance Description |
| inline_policies optional | array | Inline Policy | - |
| managed_policies optional | array | Managed Policy | '{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| customer_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| session_duration required | integer | Maximum Session Duration | 3600 |
| name required | string | Instance Name | My Instance |
| instance_id required | string | Instance ID | ssoins-12345 |
| customer_policies optional | array | Customer Managed Policy | - |
| description optional | string | Instance Description | My Instance Description |
| inline_policies optional | array | Inline Policy | - |
| managed_policies optional | array | Managed Policy | '{"description": "description", "id": "37f2e31ff86b415698d7e8eeafab445d", "name": "PolicyName"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| customer_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User Login ID | johndoe |
| name required | string | Real Name | John Doe |
| instance_id required | string | Instance ID | ssoins-12345 |
| business_unit optional | string | Business Unit | Business Unit A |
| department optional | string | Department | Department X |
| description optional | string | User Description | Description of John Doe |
| email optional | string | User Email | john.doe@example.com |
| employee_id optional | string | Employee ID | emp-12345 |
| group_ids optional | array | List of Groups the User Belongs To | 39520424-440c-41c0-9b9c-f22b2129f6f9 |
| manager optional | string | Manager | Alice Smith |
| nation_id optional | string | Nationality ID | +82 |
| password optional | string | Password | - |
| phone_number optional | string | Phone Number | 010-1234-5678 |
| temporary_password optional | boolean | Temporary Password Status | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User Login ID | johndoe |
| name required | string | Real Name | John Doe |
| instance_id required | string | Instance ID | ssoins-12345 |
| business_unit optional | string | Business Unit | Business Unit A |
| department optional | string | Department | Department X |
| description optional | string | User Description | Description of John Doe |
| email optional | string | User Email | john.doe@example.com |
| employee_id optional | string | Employee ID | emp-12345 |
| group_ids optional | array | List of Groups the User Belongs To | 39520424-440c-41c0-9b9c-f22b2129f6f9 |
| manager optional | string | Manager | Alice Smith |
| nation_id optional | string | Nationality ID | +82 |
| password optional | string | Password | - |
| phone_number optional | string | Phone Number | 010-1234-5678 |
| temporary_password optional | boolean | Temporary Password Status | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User Login ID | johndoe |
| name required | string | Real Name | John Doe |
| instance_id required | string | Instance ID | ssoins-12345 |
| business_unit optional | string | Business Unit | Business Unit A |
| department optional | string | Department | Department X |
| description optional | string | User Description | Description of John Doe |
| email optional | string | User Email | john.doe@example.com |
| employee_id optional | string | Employee ID | emp-12345 |
| group_ids optional | array | List of Groups the User Belongs To | 39520424-440c-41c0-9b9c-f22b2129f6f9 |
| manager optional | string | Manager | Alice Smith |
| nation_id optional | string | Nationality ID | +82 |
| password optional | string | Password | - |
| phone_number optional | string | Phone Number | 010-1234-5678 |
| temporary_password optional | boolean | Temporary Password Status | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_id required | string | User Login ID | johndoe |
| name required | string | Real Name | John Doe |
| instance_id required | string | Instance ID | ssoins-12345 |
| business_unit optional | string | Business Unit | Business Unit A |
| department optional | string | Department | Department X |
| description optional | string | User Description | Description of John Doe |
| email optional | string | User Email | john.doe@example.com |
| employee_id optional | string | Employee ID | emp-12345 |
| group_ids optional | array | List of Groups the User Belongs To | 39520424-440c-41c0-9b9c-f22b2129f6f9 |
| manager optional | string | Manager | Alice Smith |
| nation_id optional | string | Nationality ID | +82 |
| password optional | string | Password | - |
| phone_number optional | string | Phone Number | 010-1234-5678 |
| temporary_password optional | boolean | Temporary Password Status | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_assignment_id required | string | Assignment ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| only_user_removed optional | boolean | Exclude 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_assignment_id required | string | Assignment ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| only_user_removed optional | boolean | Exclude 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_assignment_id required | string | Assignment ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| only_user_removed optional | boolean | Exclude 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_assignment_id required | string | Assignment ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| only_user_removed optional | boolean | Exclude 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| account_assignment_ids optional | array | Assignment ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| only_user_removed optional | boolean | Exclude 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| account_assignment_ids optional | array | Assignment ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| only_user_removed optional | boolean | Exclude 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| account_assignment_ids optional | array | Assignment ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| only_user_removed optional | boolean | Exclude 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| account_assignment_ids optional | array | Assignment ID | b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 |
| only_user_removed optional | boolean | Exclude 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| group_ids required | array | List of Group IDs | group-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| group_ids required | array | List of Group IDs | group-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| group_ids required | array | List of Group IDs | group-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| group_ids required | array | List of Group IDs | group-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuids required | array | List of User IDs | user-12345 |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
4.1.13.2 - 1.2
scpcli iam-identity-center instance delete
--instance_id <value>
Description
delete a specific instance
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| policy_ids required | array | - | |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| policy_ids required | array | - | |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| policy_ids required | array | - | |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| policy_ids required | array | - | |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| target_account_name optional | string | Assigned Account Name | Admin Account |
| target_account_email optional | string | Assigned Account Email | target_account@example.com |
| permission_set_id optional | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_name optional | string | Principal Name | GROUP0407 |
| role_srn optional | string | Role SRN | srn:role:kr-j:1234:role/admin@example.com |
Responses
| Name | Description | Example |
|---|---|---|
| instance_id | Instance ID | ssoins-12345 |
| permission_sets | ||
| principal_id | Principal ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_name | Principal Name | GROUP0407 |
| principal_type | Principal Type | USER |
| role_srn | Permission Set Description | Permissions for administrators |
| target_account_email | Assigned Account Email | target_account@example.com |
| target_account_id | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| target_account_name | Assigned Account Name | Admin 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| target_account_name optional | string | Assigned Account Name | Admin Account |
| target_account_email optional | string | Assigned Account Email | target_account@example.com |
| permission_set_id optional | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_name optional | string | Principal Name | GROUP0407 |
| role_srn optional | string | Role SRN | srn:role:kr-j:1234:role/admin@example.com |
Responses
| Name | Description | Example |
|---|---|---|
| instance_id | Instance ID | ssoins-12345 |
| permission_sets | ||
| principal_id | Principal ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_name | Principal Name | GROUP0407 |
| principal_type | Principal Type | USER |
| role_srn | Permission Set Description | Permissions for administrators |
| target_account_email | Assigned Account Email | target_account@example.com |
| target_account_id | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| target_account_name | Assigned Account Name | Admin 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| target_account_name optional | string | Assigned Account Name | Admin Account |
| target_account_email optional | string | Assigned Account Email | target_account@example.com |
| permission_set_id optional | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_name optional | string | Principal Name | GROUP0407 |
| role_srn optional | string | Role SRN | srn:role:kr-j:1234:role/admin@example.com |
Responses
| Name | Description | Example |
|---|---|---|
| instance_id | Instance ID | ssoins-12345 |
| permission_sets | ||
| principal_id | Principal ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_name | Principal Name | GROUP0407 |
| principal_type | Principal Type | USER |
| role_srn | Permission Set Description | Permissions for administrators |
| target_account_email | Assigned Account Email | target_account@example.com |
| target_account_id | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| target_account_name | Assigned Account Name | Admin 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_id required | string | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| target_account_name optional | string | Assigned Account Name | Admin Account |
| target_account_email optional | string | Assigned Account Email | target_account@example.com |
| permission_set_id optional | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| principal_name optional | string | Principal Name | GROUP0407 |
| role_srn optional | string | Role SRN | srn:role:kr-j:1234:role/admin@example.com |
Responses
| Name | Description | Example |
|---|---|---|
| instance_id | Instance ID | ssoins-12345 |
| permission_sets | ||
| principal_id | Principal ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| principal_name | Principal Name | GROUP0407 |
| principal_type | Principal Type | USER |
| role_srn | Permission Set Description | Permissions for administrators |
| target_account_email | Assigned Account Email | target_account@example.com |
| target_account_id | Assigned Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| target_account_name | Assigned Account Name | Admin 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Group Name | Admin_Group |
| excluded_user_uuid optional | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Group Name | Admin_Group |
| excluded_user_uuid optional | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Group Name | Admin_Group |
| excluded_user_uuid optional | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Group Name | Admin_Group |
| excluded_user_uuid optional | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| group_count | Number of Groups the User Belongs To | 2 |
| groups | List 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_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Real Name | John Doe |
| user_id | User Login ID | johndoe |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| group_count | Number of Groups the User Belongs To | 2 |
| groups | List 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_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Real Name | John Doe |
| user_id | User Login ID | johndoe |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| group_count | Number of Groups the User Belongs To | 2 |
| groups | List 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_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Real Name | John Doe |
| user_id | User Login ID | johndoe |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| group_count | Number of Groups the User Belongs To | 2 |
| groups | List 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_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Real Name | John Doe |
| user_id | User Login ID | johndoe |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Instance ID | ssoins-12345 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| master_account_id | Master Account ID | acc-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | Instance SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Instance ID | ssoins-12345 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| master_account_id | Master Account ID | acc-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | Instance SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Instance Name | My Instance |
Responses
| Name | Description | Example |
|---|---|---|
| id | Instance ID | ssoins-12345 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| master_account_id | Master Account ID | acc-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | Instance SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Instance Name | My Instance |
Responses
| Name | Description | Example |
|---|---|---|
| id | Instance ID | ssoins-12345 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| master_account_id | Master Account ID | acc-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| srn | Instance SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| category optional | **** | Policy Type | INLINE_POLICY |
| name optional | string | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| category | Policy Type | INLINE_POLICY |
| contents | JSON Document | |
| name | Policy Name | PolicyName |
| permission_set_id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| category optional | **** | Policy Type | INLINE_POLICY |
| name optional | string | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| category | Policy Type | INLINE_POLICY |
| contents | JSON Document | |
| name | Policy Name | PolicyName |
| permission_set_id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| category optional | **** | Policy Type | INLINE_POLICY |
| name optional | string | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| category | Policy Type | INLINE_POLICY |
| contents | JSON Document | |
| name | Policy Name | PolicyName |
| permission_set_id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| category optional | **** | Policy Type | INLINE_POLICY |
| name optional | string | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | Policy ID | 37f2e31ff86b415698d7e8eeafab445d |
| category | Policy Type | INLINE_POLICY |
| contents | JSON Document | |
| name | Policy Name | PolicyName |
| permission_set_id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Permission Set Name | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| custom_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Permission Set Name | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| custom_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Permission Set Name | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| description | Permission Set Description | Permissions for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Permission Set Name | Permission Set |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| description | Permission Set Description | Permissions for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | User Login ID | johndoe |
| excluded_group_id optional | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name | Real Name | John Doe |
| user_id | User Login ID | johndoe |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | User Login ID | johndoe |
| excluded_group_id optional | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name | Real Name | John Doe |
| user_id | User Login ID | johndoe |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | User Login ID | johndoe |
| excluded_group_id optional | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name | Real Name | John Doe |
| user_id | User Login ID | johndoe |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| user_id optional | string | User Login ID | johndoe |
| excluded_group_id optional | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| excluded_account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name | Real Name | John Doe |
| user_id | User Login ID | johndoe |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| name optional | string | Group Name | Admin_Group |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| name optional | string | Group Name | Admin_Group |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| name optional | string | Group Name | Admin_Group |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Group Description | Group for administrators |
| name optional | string | Group Name | Admin_Group |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Instance Description | My Instance Description |
| session_duration optional | integer | Maximum Session Duration | 3600 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| custom_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Instance Description | My Instance Description |
| session_duration optional | integer | Maximum Session Duration | 3600 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| custom_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Instance Description | My Instance Description |
| session_duration optional | integer | Maximum Session Duration | 3600 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| customer_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| description optional | string | Instance Description | My Instance Description |
| session_duration optional | integer | Maximum Session Duration | 3600 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| customer_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| custom_policies optional | array | Customer Managed Policy | - |
| inline_policies optional | array | Inline Policy | - |
| managed_policies optional | array | Managed 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| custom_policies optional | array | Customer Managed Policy | - |
| inline_policies optional | array | Inline Policy | - |
| managed_policies optional | array | Managed 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| customer_policies optional | array | Customer Managed Policy | - |
| inline_policies optional | array | Inline Policy | - |
| managed_policies optional | array | Managed 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
| customer_policies optional | array | Customer Managed Policy | - |
| inline_policies optional | array | Inline Policy | - |
| managed_policies optional | array | Managed 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| business_unit optional | string | Business Unit | Business Unit A |
| department optional | string | Department | Department X |
| description optional | string | User Description | Description of John Doe |
| email optional | string | User Email | john.doe@example.com |
| employee_id optional | string | Employee ID | emp-12345 |
| manager optional | string | Manager | Alice Smith |
| name optional | string | Real Name | John Doe |
| nation_id optional | string | Nationality ID | +82 |
| phone_number optional | string | Phone Number | 010-1234-5678 |
| tz_id optional | string | Timezone ID | Asia/Seoul |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| business_unit optional | string | Business Unit | Business Unit A |
| department optional | string | Department | Department X |
| description optional | string | User Description | Description of John Doe |
| email optional | string | User Email | john.doe@example.com |
| employee_id optional | string | Employee ID | emp-12345 |
| manager optional | string | Manager | Alice Smith |
| name optional | string | Real Name | John Doe |
| nation_id optional | string | Nationality ID | +82 |
| phone_number optional | string | Phone Number | 010-1234-5678 |
| tz_id optional | string | Timezone ID | Asia/Seoul |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| business_unit optional | string | Business Unit | Business Unit A |
| department optional | string | Department | Department X |
| description optional | string | User Description | Description of John Doe |
| email optional | string | User Email | john.doe@example.com |
| employee_id optional | string | Employee ID | emp-12345 |
| manager optional | string | Manager | Alice Smith |
| name optional | string | Real Name | John Doe |
| nation_id optional | string | Nationality ID | +82 |
| phone_number optional | string | Phone Number | 010-1234-5678 |
| tz_id optional | string | Timezone ID | Asia/Seoul |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
| business_unit optional | string | Business Unit | Business Unit A |
| department optional | string | Department | Department X |
| description optional | string | User Description | Description of John Doe |
| email optional | string | User Email | john.doe@example.com |
| employee_id optional | string | Employee ID | emp-12345 |
| manager optional | string | Manager | Alice Smith |
| name optional | string | Real Name | John Doe |
| nation_id optional | string | Nationality ID | +82 |
| phone_number optional | string | Phone Number | 010-1234-5678 |
| tz_id optional | string | Timezone ID | Asia/Seoul |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| group_id required | string | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Group ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| description | Group Description | Group for administrators |
| instance_id | Instance ID | ssoins-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Group Name | Admin_Group |
| user_count | Number of Users in the group | 1 |
| users | List 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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Instance ID | ssoins-12345 |
| account_id | Account ID | 1234ab567cd64769e8f9g490hi304891 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| delegated_account_id | Delegated Account ID | acc-2353 |
| delegated_at | Delegation Date | 2023-10-15 14:30:00 |
| delegated_by | Delegated By | sef2w3c8c29a449dbfa8681f8f1d78e2 |
| description | Instance Description | My Instance Description |
| identity_store_config | Identity 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_id | Identity Store ID | d-12345 |
| identity_store_type | Identity Store Type | |
| last_sync_at | Last Sync Date | 2025-08-06 10:30:00 |
| last_sync_status | Last Sync Status | [‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’] |
| master_account_id | Master Account ID | acc-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Instance Name | My Instance |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| port | Port | 443 |
| public_ip | Public IP | |
| region | Region | kr-west1 |
| resource_name | Resource Name | resource-name-1 |
| resource_type | Resource Type [instance | permission-set] |
| resource_type_display_name | Resource Type Display Name | Virtual Server |
| service | Service | virtualserver |
| service_name | Service Name | Virtual Server |
| srn | Instance SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| sso_start_url | SSO Start URL | https://login.e.samsungsdscloud.com/d-12345 |
| state | State |
4.1.29.2 - 1.2
scpcli iam-identity-center instance show
--instance_id <value>
Description
show a specific instance
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Instance ID | ssoins-12345 |
| account_id | Account ID | 1234ab567cd64769e8f9g490hi304891 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| delegated_account_id | Delegated Account ID | acc-2353 |
| delegated_at | Delegation Date | 2023-10-15 14:30:00 |
| delegated_by | Delegated By | sef2w3c8c29a449dbfa8681f8f1d78e2 |
| description | Instance Description | My Instance Description |
| identity_store_config | Identity 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_id | Identity Store ID | d-12345 |
| identity_store_type | Identity Store Type | |
| last_sync_at | Last Sync Date | 2025-08-06 10:30:00 |
| last_sync_status | Last Sync Status | [‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’] |
| master_account_id | Master Account ID | acc-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Instance Name | My Instance |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| resource_name | Resource Name | resource-name-1 |
| resource_type | Resource Type [instance | permission-set] |
| resource_type_display_name | Resource Type Display Name | Virtual Server |
| service | Service | virtualserver |
| service_name | Service Name | Virtual Server |
| srn | Instance SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| sso_start_url | SSO Start URL | https://login.e.samsungsdscloud.com/d-12345 |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Instance ID | ssoins-12345 |
| account_id | Account ID | 1234ab567cd64769e8f9g490hi304891 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| delegated_account_id | Delegated Account ID | acc-2353 |
| delegated_at | Delegation Date | 2023-10-15 14:30:00 |
| delegated_by | Delegated By | sef2w3c8c29a449dbfa8681f8f1d78e2 |
| description | Instance Description | My Instance Description |
| identity_store_config | Identity 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_id | Identity Store ID | d-12345 |
| identity_store_type | Identity Store Type | |
| last_sync_at | Last Sync Date | 2025-08-06 10:30:00 |
| last_sync_status | Last Sync Status | [‘CREATED’, ‘RUNNING’, ‘FINISHED’, ‘FAILED’, ‘NONE’, ‘ABORTED’] |
| master_account_id | Master Account ID | acc-12345 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Instance Name | My Instance |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | Region | kr-west1 |
| resource_name | Resource Name | resource-name-1 |
| resource_type | Resource Type [instance | permission-set] |
| resource_type_display_name | Resource Type Display Name | Virtual Server |
| service | Service | virtualserver |
| service_name | Service Name | Virtual Server |
| srn | Instance SRN | srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 |
| sso_start_url | SSO Start URL | https://login.e.samsungsdscloud.com/d-12345 |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| account_id | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| custom_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| resource_name | ||
| resource_type | ||
| resource_type_display_name | ||
| service | ||
| service_name | ||
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| account_id | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| custom_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| resource_name | ||
| resource_type | ||
| resource_type_display_name | ||
| service | ||
| service_name | ||
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| account_id | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| customer_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| resource_name | ||
| resource_type | ||
| resource_type_display_name | ||
| service | ||
| service_name | ||
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| permission_set_id required | string | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Permission Set ID | e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 |
| account_id | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | |
| customer_policies | Customer Managed Policy | |
| description | Permission Set Description | Permissions for administrators |
| inline_policies | Inline Policy | |
| instance_id | Instance ID | ssoins-12345 |
| managed_policies | Managed Policy | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | |
| name | Permission Set Name | Permission Set |
| resource_name | ||
| resource_type | ||
| resource_type_display_name | ||
| service | ||
| service_name | ||
| session_duration | Maximum Session Duration | 3600 |
| srn | Permission Set SRN | srn: |
| state | State |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| user_uuid required | string | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| instance_id required | string | Instance ID | ssoins-12345 |
Responses
| Name | Description | Example |
|---|---|---|
| id | User ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| business_unit | Business Unit | Business Unit A |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| creator_name | Creator Name | John Doe |
| department | Department | Department X |
| description | User Description | Description of John Doe |
| User Email | john.doe@example.com | |
| email_authenticated | Email Authentication Status | |
| employee_id | Employee ID | emp-12345 |
| groups | List of Groups | |
| instance_id | Instance ID | ssoins-12345 |
| last_login_at | Last Login Date | 2024-12-19 01:09:05.000 |
| last_password_update_at | Last Password Update Date | 2026-03-17T09:58:31.498976 |
| manager | Manager | Alice Smith |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modifier_name | Modifier Name | Smith |
| name | Real Name | John Doe |
| nation_id | Nationality ID | +82 |
| password | Password | |
| password_failed_count | Password Failure Count | 6 |
| password_reuse_count | Password Reuse Limit Count | 6 |
| phone_authenticated | Phone Authentication Status | |
| phone_number | Phone Number | 010-1234-5678 |
| temporary_password | Temporary Password Status | |
| tz_id | Timezone ID | Asia/Seoul |
| user_id | User Login ID | johndoe |
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.
| Version | Status | Not Before |
|---|---|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20260223 |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_save_type required | string | Trail save type | JSON |
| trail_name required | string | Trail name | TestTrail01 |
| bucket_region required | string | Bucket region | RegionOne |
| bucket_name required | string | Bucket name | TestBucket00 |
| account_id required | string | Account ID | ACCOUNT_ID-ABCDEF1234 |
| iam_role_id optional | string | Iam Role ID. Only for Service Watch Trail.(service_watch_yn = Y) | IAM_ROLE_ID-ABCDEF1234 |
| log_archive_account_id optional | string | Log Archive Account ID. Only for Organization Trail.(organization_trail_yn = y) | ACCOUNT_ID-ABCDEF1234 |
| log_group_name optional | string | Log Group Name. Only for Service Watch Trail.(service_watch_yn = Y) | /scp/loggingaudit/trail/trailname-log-group-20260205120000 |
| log_type_total_yn optional | string | Target log type total y/n | N |
| log_verification_yn optional | string | Log verification y/n | N |
| organization_trail_yn optional | string | Organization trail y/n | N |
| region_names optional | array | Region name list | - |
| region_total_yn optional | string | Target region total y/n | Y |
| resource_type_total_yn optional | string | Target resource type total y/n | Y |
| service_watch_yn optional | string | Service Watch y/n | Y |
| tag_create_requests optional | array | Tag create requests | {'key': '11', 'value': '22'} |
| target_log_types optional | array | Target log type list | - |
| target_resource_types optional | array | Target resource type list | - |
| target_users optional | array | Target user list | - |
| trail_description optional | string | Trail description | This is a test trail |
| user_total_yn optional | string | Target user total y/n | Y |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| iam_role_id | Iam Role ID | IAM_ROLE_ID-ABCDEF1234 |
| log_archive_account_id | Log Archive Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_group_name | Log Group Name | /scp/loggingaudit/trail/trailname-log-group-20260205120000 |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_trail_yn | Organization trail y/n | Y |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| service_watch_yn | Service Watch y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2026-02-26T07:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2026-02-16T08:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2026-02-26T07:00:00Z |
| trail_batch_success_at | Trail batch success date | 2026-02-26T07:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2026-02-26T07:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2026-02-16T08:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2026-02-26T07:00:00Z |
| trail_batch_success_at | Trail batch success date | 2026-02-26T07:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail 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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| time_zone_info required | string | Timezone info | Asia/Seoul |
| start_at required | string | Query start date | 2025-11-28T08:00:00Z |
| file_type required | string | Download file type | JSON |
| end_at required | string | Query finish date | 2026-02-26T08:00:00Z |
| product_name optional | string | Product name | - |
| region optional | string | Region name | - |
| resource_name optional | string | Resource name | - |
| resource_type optional | string | Resource type | - |
| root_resource_id optional | string | Root resource ID | - |
| status optional | string | Task result | - |
| user_name optional | string | Username | - |
Responses
| Name | Description | Example |
|---|---|---|
| EventTopic | Event type | |
| RegionName | Region name | |
| ResourceId | Resource ID | |
| ResourceName | Resource name | |
| ResourceType | Resource type | |
| WorkInfo | Event name | |
| WorkResult | Task result | |
| WorkTime | Work time | |
| WorkerEmail | Worker email | |
| WorkerID | Worker ID | |
| WorkerName | Worker 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| time_zone_info required | string | Timezone info | Asia/Seoul |
| start_at required | string | Query start date | 2025-11-28T08:00:00Z |
| file_type required | string | Download file type | JSON |
| end_at required | string | Query finish date | 2026-02-26T08:00:00Z |
| product_name optional | string | Product name | - |
| region optional | string | Region name | - |
| resource_name optional | string | Resource name | - |
| resource_type optional | string | Resource type | - |
| root_resource_id optional | string | Root resource ID | - |
| status optional | string | Task result | - |
| user_name optional | string | Username | - |
Responses
| Name | Description | Example |
|---|---|---|
| EventTopic | Event type | |
| RegionName | Region name | |
| ResourceId | Resource ID | |
| ResourceName | Resource name | |
| ResourceType | Resource type | |
| WorkInfo | Event name | |
| WorkResult | Task result | |
| WorkTime | Work time | |
| WorkerEmail | Worker email | |
| WorkerID | Worker ID | |
| WorkerName | Worker 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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| end_at required | string | Query finish date | 2026-02-26T08:00:00Z |
| start_at required | string | Query start date | 2025-11-28T08:00:00Z |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| resource_id optional | string | Resource ID | - |
| resource_name optional | string | Resource name | - |
| resource_type optional | string | Resource type | - |
| product_name optional | string | Product name | - |
| product_type optional | string | Product type | - |
| status optional | string | Task result | - |
| event_type optional | string | Event type | - |
| user_id optional | string | User ID | - |
| user_name optional | string | Username | - |
| region optional | string | Region name | - |
| root_resource_id optional | string | Root resource ID | - |
| service_type optional | string | Service type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Log ID | ID-A1B2C3D4E5F6G7H8I9J0 |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| event_name | Event name | scp-extension.event.create |
| event_type | Event type | scp-extension.event.create |
| product_name | Product name | scp-extension |
| product_type | Product type | scp-extension |
| region | Region name | RegionOne |
| request_user_name | Username | Hong Gildong |
| resource_id | Resource ID | RESOURCE_ID-ABCDEF1234 |
| resource_name | Resource name | RESOURCE_NAME-ABCDEF1234 |
| resource_type | Resource type | scp-extension |
| role_name | Username | Tester |
| status | Task result | Success |
| timestamp | Timestamp | 2026-02-26T08:00:00Z |
| type | Type | ROLE |
| user_id | User ID | USER_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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| end_at required | string | Query finish date | 2026-02-26T08:00:00Z |
| start_at required | string | Query start date | 2025-11-28T08:00:00Z |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| resource_id optional | string | Resource ID | - |
| resource_name optional | string | Resource name | - |
| resource_type optional | string | Resource type | - |
| product_name optional | string | Product name | - |
| product_type optional | string | Product type | - |
| status optional | string | Task result | - |
| event_type optional | string | Event type | - |
| user_id optional | string | User ID | - |
| user_name optional | string | Username | - |
| region optional | string | Region name | - |
| root_resource_id optional | string | Root resource ID | - |
| service_type optional | string | Service type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Log ID | ID-A1B2C3D4E5F6G7H8I9J0 |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| event_name | Event name | scp-extension.event.create |
| event_type | Event type | scp-extension.event.create |
| product_name | Product name | scp-extension |
| product_type | Product type | scp-extension |
| region | Region name | RegionOne |
| request_user_name | Username | Hong Gildong |
| resource_id | Resource ID | RESOURCE_ID-ABCDEF1234 |
| resource_name | Resource name | RESOURCE_NAME-ABCDEF1234 |
| resource_type | Resource type | scp-extension |
| role_name | Username | Tester |
| status | Task result | Success |
| timestamp | Timestamp | 2026-02-26T08:00:00Z |
| type | Type | ROLE |
| user_id | User ID | USER_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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| trail_name optional | string | Trail name | - |
| bucket_name optional | string | Bucket name | - |
| state optional | string | Trail state | - |
| resource_type optional | string | Resource type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| iam_role_id | Iam Role ID | IAM_ROLE_ID-ABCDEF1234 |
| log_archive_account_id | Log Archive Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_group_name | Log Group Name | /scp/loggingaudit/trail/trailname-log-group-20260205120000 |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_trail_yn | Organization trail y/n | Y |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| service_watch_yn | Service Watch y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2026-02-26T07:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2026-02-16T08:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2026-02-26T07:00:00Z |
| trail_batch_success_at | Trail batch success date | 2026-02-26T07:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| trail_name optional | string | Trail name | - |
| bucket_name optional | string | Bucket name | - |
| state optional | string | Trail state | - |
| resource_type optional | string | Resource type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2026-02-26T07:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2026-02-16T08:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2026-02-26T07:00:00Z |
| trail_batch_success_at | Trail batch success date | 2026-02-26T07:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
| iam_role_id optional | string | Iam Role ID | IAM_ROLE_ID-ABCDEF1234 |
| log_group_name optional | string | Log Group Name | /scp/loggingaudit/trail/trailname-log-group-20260205120000 |
| log_type_total_yn optional | string | Target log type total y/n | N |
| log_verification_yn optional | string | Log verification y/n | N |
| organization_trail_yn optional | string | Organization trail y/n | Y |
| region_names optional | array | Region name list | - |
| region_total_yn optional | string | Target region total y/n | Y |
| resource_type_total_yn optional | string | Target resource type total y/n | Y |
| service_watch_yn optional | string | Service Watch y/n | Y |
| target_log_types optional | array | Target log type list | - |
| target_resource_types optional | array | Target resource type list | - |
| target_users optional | array | Target user list | - |
| trail_description optional | string | Trail description | This is a test trail |
| trail_save_type optional | string | Trail save type | JSON |
| user_total_yn optional | string | Target user total y/n | Y |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
| log_type_total_yn optional | string | Target log type total y/n | N |
| log_verification_yn optional | string | Log verification y/n | N |
| region_names optional | array | Region name list | - |
| region_total_yn optional | string | Target region total y/n | Y |
| resource_type_total_yn optional | string | Target resource type total y/n | Y |
| target_log_types optional | array | Target log type list | - |
| target_resource_types optional | array | Target resource type list | - |
| target_users optional | array | Target user list | - |
| trail_description optional | string | Trail description | This is a test trail |
| trail_save_type optional | string | Trail save type | JSON |
| user_total_yn optional | string | Target user total y/n | Y |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| logging_id required | string | Log ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Log ID | ID-A1B2C3D4E5F6G7H8I9J0 |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| details | Audit detail contents(JSON String) | |
| event_name | Event name | scp-extension.event.create |
| event_type | Event type | scp-extension.event.create |
| product_name | Product name | scp-extension |
| product_type | Product type | scp-extension |
| region | Region name | RegionOne |
| request_user_name | Username | Hong Gildong |
| resource_id | Resource ID | RESOURCE_ID-ABCDEF1234 |
| resource_name | Resource name | RESOURCE_NAME-ABCDEF1234 |
| resource_type | Resource type | scp-extension |
| role_name | Username | Tester |
| status | Task result | Success |
| timestamp | Timestamp | 2026-02-26T08:00:00Z |
| type | Type | ROLE |
| user_id | User ID | USER_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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| logging_id required | string | Log ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Log ID | ID-A1B2C3D4E5F6G7H8I9J0 |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| details | Audit detail contents(JSON String) | |
| event_name | Event name | scp-extension.event.create |
| event_type | Event type | scp-extension.event.create |
| product_name | Product name | scp-extension |
| product_type | Product type | scp-extension |
| region | Region name | RegionOne |
| request_user_name | Username | Hong Gildong |
| resource_id | Resource ID | RESOURCE_ID-ABCDEF1234 |
| resource_name | Resource name | RESOURCE_NAME-ABCDEF1234 |
| resource_type | Resource type | scp-extension |
| role_name | Username | Tester |
| status | Task result | Success |
| timestamp | Timestamp | 2026-02-26T08:00:00Z |
| type | Type | ROLE |
| user_id | User ID | USER_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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| iam_role_id | Iam Role ID | IAM_ROLE_ID-ABCDEF1234 |
| log_archive_account_id | Log Archive Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_group_name | Log Group Name | /scp/loggingaudit/trail/trailname-log-group-20260205120000 |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_trail_yn | Organization trail y/n | Y |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| service_watch_yn | Service Watch y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2026-02-26T07:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2026-02-16T08:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2026-02-26T07:00:00Z |
| trail_batch_success_at | Trail batch success date | 2026-02-26T07:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2026-02-26T07:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2026-02-16T08:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2026-02-26T07:00:00Z |
| trail_batch_success_at | Trail batch success date | 2026-02-26T07:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| iam_role_id | Iam Role ID | IAM_ROLE_ID-ABCDEF1234 |
| log_archive_account_id | Log Archive Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_group_name | Log Group Name | /scp/loggingaudit/trail/trailname-log-group-20260205120000 |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_trail_yn | Organization trail y/n | Y |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| service_watch_yn | Service Watch y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2026-02-26T07:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2026-02-16T08:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2026-02-26T07:00:00Z |
| trail_batch_success_at | Trail batch success date | 2026-02-26T07:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2026-02-26T07:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2026-02-16T08:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2026-02-26T07:00:00Z |
| trail_batch_success_at | Trail batch success date | 2026-02-26T07:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| iam_role_id | Iam Role ID | IAM_ROLE_ID-ABCDEF1234 |
| log_archive_account_id | Log Archive Account ID | ACCOUNT_ID-ABCDEF1234 |
| log_group_name | Log Group Name | /scp/loggingaudit/trail/trailname-log-group-20260205120000 |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| organization_trail_yn | Organization trail y/n | Y |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| service_watch_yn | Service Watch y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2026-02-26T07:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2026-02-16T08:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2026-02-26T07:00:00Z |
| trail_batch_success_at | Trail batch success date | 2026-02-26T07:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| trail_id required | string | Trail ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | ACCOUNT_ID-ABCDEF1234 |
| account_name | Account name | Test Account |
| bucket_name | Bucket name | Bucket001 |
| bucket_region | Bucket region | RegionOne |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| created_user_id | Created user ID | kim.samsung@samsung.com |
| del_yn | Delete y/n | N |
| log_type_total_yn | Target log type total y/n | Y |
| log_verification_yn | Log verification y/n | N |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_names | Region name list | [] |
| region_total_yn | Target region total y/n | Y |
| resource_type_total_yn | Target resource type total y/n | Y |
| state | Trail state | ACTIVE |
| target_log_types | Target log type list | [] |
| target_resource_types | Target resource type list | [] |
| target_users | Target user list | [] |
| trail_batch_end_at | Trail batch end date | 2026-02-26T07:00:00Z |
| trail_batch_first_start_at | Trail batch first start date | 2026-02-16T08:00:00Z |
| trail_batch_last_state | Trail batch last state | success |
| trail_batch_start_at | Trail batch start date | 2026-02-26T07:00:00Z |
| trail_batch_success_at | Trail batch success date | 2026-02-26T07:00:00Z |
| trail_description | Trail description | test trail |
| trail_name | Trail name | Trail-0001 |
| trail_save_type | Trail save type | JSON |
| user_total_yn | Target user total y/n | Y |
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.
| Version | Status | Not Before |
|---|---|---|
| 1.0 | CURRENT | - |
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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | string | Resource Type | - |
| bucket_name required | string | Storage Bucket Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Network Logging Storage ID | |
| account_id | Account ID | |
| bucket_name | Storage Bucket Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| resource_type | Resource 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| network_logging_storage_id required | string | Network 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | Resource Type | - |
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| resource_id optional | string | Resource ID | - |
| resource_name optional | string | Resource Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Network Logging Configuration ID | |
| account_id | Account ID | |
| bucket_name | Storage Bucket Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| down_interface | Downlink Interface | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| resource_id | Resource ID | |
| resource_name | Resource Name | |
| resource_type | Resource Type | |
| security_group_log_id | Security Group Log ID | |
| up_interface | Uplink 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | Resource Type | - |
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | Network Logging Storage ID | |
| account_id | Account ID | |
| bucket_name | Storage Bucket Name | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| resource_type | Resource 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.
| Version | Status | Not Before |
|---|---|---|
| 1.2 | CURRENT | - |
| 1.1 | DEPRECATED | 20260531 |
| 1.0 | DEPRECATED | 20251231 |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| invitation_id required | string | Invitation ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| invitation_id required | string | Invitation ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| invitation_id required | string | Invitation ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_ids required | array | Target Info | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| policy_ids required | array | Control Policy List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| entity required | string | Entity Type | POLICY |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | Error Code | Conflict |
| failed_caused | Failure Cause | Account 482d111a302547fbbd11ee0141ea23bb is not found |
| failed_id | Failed ID | ou-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_ids required | array | Target Info | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| policy_ids required | array | Control Policy List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| entity required | string | Entity Type | POLICY |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | Error Code | Conflict |
| failed_caused | Failure Cause | Account 482d111a302547fbbd11ee0141ea23bb is not found |
| failed_id | Failed ID | ou-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_ids required | array | Target Info | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| policy_ids required | array | Control Policy List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| entity required | string | Entity Type | POLICY |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | Error Code | Conflict |
| failed_caused | Failure Cause | Account 482d111a302547fbbd11ee0141ea23bb is not found |
| failed_id | Failed ID | ou-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | Invitation ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | Invitation ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | Invitation ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id optional | string | Organization ID | o-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_name required | string | Role Name | OrganizationAccountAccessRole |
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name required | string | Account Name | score-account |
| login_id required | string | Login ID | log-archive@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| failed | Account Create Fail Info | |
| success | Account 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_name required | string | Role Name | OrganizationAccountAccessRole |
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name required | string | Account Name | score-account |
| login_id required | string | Login ID | log-archive@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| failed | Account Create Fail Info | |
| success | Account 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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_name required | string | Role Name | OrganizationAccountAccessRole |
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name required | string | Account Name | score-account |
| login_id required | string | Login ID | log-archive@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| failed | Account Create Fail Info | |
| success | Account 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy Version | - |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| document | Delegation 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_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy Version | - |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| document | Delegation 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_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy Version | - |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| document | Delegation 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_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_login_ids required | array | Invitation Receiver Account Email List | score-1@samsung.com |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | Error Code | Invitation.AlreadySentError |
| failed_caused | Failure Reason | Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found |
| failed_id | Organization 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_login_ids required | array | Invitation Receiver Account Email List | score-1@samsung.com |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | Error Code | Invitation.AlreadySentError |
| failed_caused | Failure Reason | Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found |
| failed_id | Organization 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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_login_ids required | array | Invitation Receiver Account Email List | score-1@samsung.com |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | Error Code | Invitation.AlreadySentError |
| failed_caused | Failure Reason | Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found |
| failed_id | Organization 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Organization Name | My Organization |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| delegation_account_id | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_email | Master Account Email | admin@example.com |
| master_account_id | Master Account ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Organization Name | My Organization |
| root_unit_id | Root Unit ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| srn | Organization SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn | Control Policy Usage YN | True |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Organization Name | My Organization |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| delegation_account_id | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_email | Master Account Email | admin@example.com |
| master_account_id | Master Account ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Organization Name | My Organization |
| root_unit_id | Root Unit ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| srn | Organization SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn | Control Policy Usage YN | True |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Organization Name | My Organization |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| delegation_account_id | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_email | Master Account Email | admin@example.com |
| master_account_id | Master Account ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Organization Name | My Organization |
| root_unit_id | Root Unit ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| srn | Organization SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn | Control Policy Usage YN | True |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Organization Unit Name | score-organization-unit |
| description optional | string | Organization Unit Description | Score Organization Unit |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id optional | string | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| policy_ids optional | array | Control Policy List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
Responses
| Name | Description | Example |
|---|---|---|
| organization_unit | Organization 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Organization Unit Name | score-organization-unit |
| description optional | string | Organization Unit Description | Score Organization Unit |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id optional | string | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| policy_ids optional | array | Control Policy List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
Responses
| Name | Description | Example |
|---|---|---|
| organization_unit | Organization 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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Organization Unit Name | score-organization-unit |
| description optional | string | Organization Unit Description | Score Organization Unit |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id optional | string | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| policy_ids optional | array | Control Policy List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
Responses
| Name | Description | Example |
|---|---|---|
| organization_unit | Organization 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name required | string | Service Control Policy Name | MyPolicy |
| description required | string | Policy Description | This is an example policy. |
| type optional | string | Service Control Policy Type | MANAGED |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy Version | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | Policy Category | SCP |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| description | Policy Description | This is an example policy. |
| document | Policy Document | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Service Control Policy Name | MyPolicy |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| service_name | Service Name | Organization |
| source | Policy Creation Subject | ORGANIZATION |
| srn | Policy SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2 |
| state | Policy State | ACTIVE |
| type | Service Control Policy Type | MANAGED |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name required | string | Service Control Policy Name | MyPolicy |
| description required | string | Policy Description | This is an example policy. |
| type optional | string | Service Control Policy Type | MANAGED |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy Version | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | Policy Category | SCP |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| description | Policy Description | This is an example policy. |
| document | Policy Document | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Service Control Policy Name | MyPolicy |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| service_name | Service Name | Organization |
| source | Policy Creation Subject | ORGANIZATION |
| srn | Policy SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2 |
| state | Policy State | ACTIVE |
| type | Service Control Policy Type | MANAGED |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name required | string | Service Control Policy Name | MyPolicy |
| description required | string | Policy Description | This is an example policy. |
| type optional | string | Service Control Policy Type | MANAGED |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy Version | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | Policy Category | SCP |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| description | Policy Description | This is an example policy. |
| document | Policy Document | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Service Control Policy Name | MyPolicy |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| service_name | Service Name | Organization |
| source | Policy Creation Subject | ORGANIZATION |
| srn | Policy SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2 |
| state | Policy State | ACTIVE |
| type | Service Control Policy Type | MANAGED |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| invitation_id required | string | Invitation ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| invitation_id required | string | Invitation ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| invitation_id required | string | Invitation ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| organization_id optional | string | Organization ID | o-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | Organization Unit ID List | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | Organization Unit ID List | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | Organization Unit ID List | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | Organization ID | o-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| ids required | array | Service Control Policy List ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| ids required | array | Service Control Policy List ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| ids required | array | Service Control Policy List ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
7.1.17 - ListAccountInvitations
7.1.17.1 - 1.2
scpcli organization account invitation list
Description
get account invitation list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| expired_time | Invitation Expired Datetime | 2024-04-30T12:34:56.789Z |
| master_account_email | Master Account Email | admin@example.com |
| master_account_id | Master Account Name | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_login_id | Login ID | log-archive@samsung.com |
| master_account_name | Master Account Name | CoreKim |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| organization_name | Organization Name | My Organization |
| requested_time | Invitation Request Datetime | 2024-04-17T12:34:56.789Z |
| state | Invitation State | INVITING |
| target_account_id | Invitation Receiver Account ID | 338c2fc8c29a449dbfa8681f8f1d78e5 |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| expired_time | Invitation Expired Datetime | 2024-04-30T12:34:56.789Z |
| master_account_email | Master Account Email | admin@example.com |
| master_account_id | Master Account Name | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_login_id | Login ID | log-archive@samsung.com |
| master_account_name | Master Account Name | CoreKim |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| organization_name | Organization Name | My Organization |
| requested_time | Invitation Request Datetime | 2024-04-17T12:34:56.789Z |
| state | Invitation State | INVITING |
| target_account_id | Invitation Receiver Account ID | 338c2fc8c29a449dbfa8681f8f1d78e5 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| expired_time | Invitation Expired Datetime | 2024-04-30T12:34:56.789Z |
| master_account_email | Master Account Email | admin@example.com |
| master_account_id | Master Account Name | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_login_id | Login ID | log-archive@samsung.com |
| master_account_name | Master Account Name | CoreKim |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| organization_name | Organization Name | My Organization |
| requested_time | Invitation Request Datetime | 2024-04-17T12:34:56.789Z |
| state | Invitation State | INVITING |
| target_account_id | Invitation Receiver Account ID | 338c2fc8c29a449dbfa8681f8f1d78e5 |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| name optional | string | Account Name | score-account |
| email optional | string | Account Email | score@samsung.com |
| login_id optional | string | Login ID | log-archive@samsung.com |
| joined_start_date optional | string | Joined Start Datetime | 2024-05-17T12:34:56.789Z |
| joined_end_date optional | string | Joined End Datetime | 2024-05-17T12:34:56.789Z |
| joined_method optional | **** | Joined Method | INVITED |
| exclude_policy_id optional | string | Policy ID to Exclude | 238c2fc8c29a449dbfa8681f8f1d78e2 |
| parent_unit_id optional | string | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name optional | string | Root or Parent Organization Unit Name | parent-unit-name |
| type optional | **** | Account Type | MEMBER |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| Account Email | score@samsung.com | |
| joined_method | Joined Method | INVITED |
| joined_time | Joined Datetime | 2024-05-17T12:34:56.789Z |
| login_id | Login ID | log-archive@samsung.com |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Account Name | score-account |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | Root or Parent Organization Unit Name | parent-unit-name |
| state | Account Status | ACTIVE |
| type | Account Type | MEMBER |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| name optional | string | Account Name | score-account |
| email optional | string | Account Email | score@samsung.com |
| login_id optional | string | Login ID | log-archive@samsung.com |
| joined_start_date optional | string | Joined Start Datetime | 2024-05-17T12:34:56.789Z |
| joined_end_date optional | string | Joined End Datetime | 2024-05-17T12:34:56.789Z |
| joined_method optional | **** | Joined Method | INVITED |
| exclude_policy_id optional | string | Policy ID to Exclude | 238c2fc8c29a449dbfa8681f8f1d78e2 |
| parent_unit_id optional | string | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name optional | string | Root or Parent Organization Unit Name | parent-unit-name |
| type optional | **** | Account Type | MEMBER |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| Account Email | score@samsung.com | |
| joined_method | Joined Method | INVITED |
| joined_time | Joined Datetime | 2024-05-17T12:34:56.789Z |
| login_id | Login ID | log-archive@samsung.com |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Account Name | score-account |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | Root or Parent Organization Unit Name | parent-unit-name |
| state | Account Status | ACTIVE |
| type | Account Type | MEMBER |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| name optional | string | Account Name | score-account |
| email optional | string | Account Email | score@samsung.com |
| login_id optional | string | Login ID | log-archive@samsung.com |
| joined_start_date optional | string | Joined Start Datetime | 2024-05-17T12:34:56.789Z |
| joined_end_date optional | string | Joined End Datetime | 2024-05-17T12:34:56.789Z |
| joined_method optional | **** | Joined Method | INVITED |
| exclude_policy_id optional | string | Policy ID to Exclude | 238c2fc8c29a449dbfa8681f8f1d78e2 |
| parent_unit_id optional | string | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name optional | string | Root or Parent Organization Unit Name | parent-unit-name |
| type optional | **** | Account Type | MEMBER |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| Account Email | score@samsung.com | |
| joined_method | Joined Method | INVITED |
| joined_time | Joined Datetime | 2024-05-17T12:34:56.789Z |
| login_id | Login ID | log-archive@samsung.com |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Account Name | score-account |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | Root or Parent Organization Unit Name | parent-unit-name |
| state | Account Status | ACTIVE |
| type | Account Type | MEMBER |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | Master Account Name | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| account_name optional | string | Master Account Name | CoreKim |
| account_email optional | string | Master Account Email | admin@example.com |
| state optional | **** | Invitation State | INVITING |
| login_id optional | string | Login ID | log-archive@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| account_email | Master Account Email | admin@example.com |
| account_name | Master Account Name | CoreKim |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| login_id | Login ID | log-archive@samsung.com |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| state | Invitation State | INVITING |
| target_account_id | Master Account Name | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | Master Account Name | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| account_name optional | string | Master Account Name | CoreKim |
| account_email optional | string | Master Account Email | admin@example.com |
| state optional | **** | Invitation State | INVITING |
| login_id optional | string | Login ID | log-archive@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| account_email | Master Account Email | admin@example.com |
| account_name | Master Account Name | CoreKim |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| login_id | Login ID | log-archive@samsung.com |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| state | Invitation State | INVITING |
| target_account_id | Master Account Name | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | Master Account Name | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| account_name optional | string | Master Account Name | CoreKim |
| account_email optional | string | Master Account Email | admin@example.com |
| state optional | **** | Invitation State | INVITING |
| login_id optional | string | Login ID | log-archive@samsung.com |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| account_email | Master Account Email | admin@example.com |
| account_name | Master Account Name | CoreKim |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| login_id | Login ID | log-archive@samsung.com |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| state | Invitation State | INVITING |
| target_account_id | Master Account Name | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Organization Name | My Organization |
| master_account_id optional | string | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| delegation_account_id | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_id | Master Account ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Organization Name | My Organization |
| root_unit_id | Root Unit ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| use_scp_yn | Control Policy Usage YN | True |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Organization Name | My Organization |
| master_account_id optional | string | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| delegation_account_id | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_id | Master Account ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Organization Name | My Organization |
| root_unit_id | Root Unit ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| use_scp_yn | Control Policy Usage YN | True |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Organization Name | My Organization |
| master_account_id optional | string | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| delegation_account_id | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_id | Master Account ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| name | Organization Name | My Organization |
| root_unit_id | Root Unit ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| use_scp_yn | Control Policy Usage YN | True |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_unit_id required | string | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name optional | string | Organization Unit Name | score-organization-unit |
| exclude_policy_id optional | string | Policy ID to Exclude | 238c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization Unit ID or Organization Account ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| depth | Hierarchy (0~5) | 1 |
| Account Email | score@samsung.com | |
| joined_method | Joined Method | INVITED |
| joined_time | Joined Datetime | 2024-05-17T12:34:56.789Z |
| login_id | Login ID | log-archive@samsung.com |
| name | Organization Unit Name or Account Name | score-organization-unit |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | Root or Parent Organization Unit Name | parent-unit-name |
| type | Type (Root or Organization Unit) or Account Type | MEMBER |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_unit_id required | string | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name optional | string | Organization Unit Name | score-organization-unit |
| exclude_policy_id optional | string | Policy ID to Exclude | 238c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization Unit ID or Organization Account ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| depth | Hierarchy (0~5) | 1 |
| Account Email | score@samsung.com | |
| joined_method | Joined Method | INVITED |
| joined_time | Joined Datetime | 2024-05-17T12:34:56.789Z |
| login_id | Login ID | log-archive@samsung.com |
| name | Organization Unit Name or Account Name | score-organization-unit |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | Root or Parent Organization Unit Name | parent-unit-name |
| type | Type (Root or Organization Unit) or Account Type | MEMBER |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_unit_id required | string | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| name optional | string | Organization Unit Name | score-organization-unit |
| exclude_policy_id optional | string | Policy ID to Exclude | 238c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization Unit ID or Organization Account ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| depth | Hierarchy (0~5) | 1 |
| Account Email | score@samsung.com | |
| joined_method | Joined Method | INVITED |
| joined_time | Joined Datetime | 2024-05-17T12:34:56.789Z |
| login_id | Login ID | log-archive@samsung.com |
| name | Organization Unit Name or Account Name | score-organization-unit |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| parent_unit_id | Root or Parent Organization Unit ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| type | Type (Root or Organization Unit) or Account Type | MEMBER |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| depth | Hierarchy (0~5) | 1 |
| description | Organization Unit Description | Score Organization Unit |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Organization Unit Name | score-organization-unit |
| parent_unit_id | Type (Root or Organization Unit) | ou-fc8c29a138d78e24bf1fa86812fc8b |
| service_name | Service Name | Organization |
| srn | Organization Unit SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| type | Type (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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| depth | Hierarchy (0~5) | 1 |
| description | Organization Unit Description | Score Organization Unit |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Organization Unit Name | score-organization-unit |
| parent_unit_id | Type (Root or Organization Unit) | ou-fc8c29a138d78e24bf1fa86812fc8b |
| service_name | Service Name | Organization |
| srn | Organization Unit SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| type | Type (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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| depth | Hierarchy (0~5) | 1 |
| description | Organization Unit Description | Score Organization Unit |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Organization Unit Name | score-organization-unit |
| parent_unit_id | Type (Root or Organization Unit) | ou-fc8c29a138d78e24bf1fa86812fc8b |
| service_name | Service Name | Organization |
| srn | Organization Unit SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| type | Type (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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_id required | string | Target ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_category optional | **** | Policy Category | SCP |
| name optional | string | Control Policy Name | test-policy-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| link_types | Link Type | {‘DIRECTED’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’, ’target_type’: ‘OU’}], ‘INHERITED’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’, ’target_type’: ‘ROOT’}]} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| policy_name | Control Policy Name | test-policy-name |
| policy_type | Control Policy Type | SYSTEM_MANAGED |
| source | Policy Creation Subject | ORGANIZATION |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_id required | string | Target ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_category optional | **** | Policy Category | SCP |
| name optional | string | Control Policy Name | test-policy-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| link_types | Link Type | {‘DIRECTED’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’, ’target_type’: ‘OU’}], ‘INHERITED’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’, ’target_type’: ‘ROOT’}]} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| policy_name | Control Policy Name | test-policy-name |
| policy_type | Control Policy Type | SYSTEM_MANAGED |
| source | Policy Creation Subject | ORGANIZATION |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_id required | string | Target ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_category optional | **** | Policy Category | SCP |
| name optional | string | Control Policy Name | test-policy-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| link_types | Link Type | {‘DIRECTED’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’, ’target_type’: ‘OU’}], ‘INHERITED’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’, ’target_type’: ‘ROOT’}]} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| policy_name | Control Policy Name | test-policy-name |
| policy_type | Control Policy Type | SYSTEM_MANAGED |
| source | Policy Creation Subject | ORGANIZATION |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name optional | array | Service Control Policy Name | M |
| type optional | **** | Service Control Policy Type | MANAGED |
| exclude_target_id optional | string | Target ID to Exclude | 112c2fc8c29a449dbfa8681f8f1d7442 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | Policy Category | SCP |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| description | Policy Description | This is an example policy. |
| document | Policy Document | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Service Control Policy Name | MyPolicy |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| source | Policy Creation Subject | ORGANIZATION |
| state | Policy State | ACTIVE |
| type | Service Control Policy Type | MANAGED |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name optional | array | Service Control Policy Name | M |
| type optional | **** | Service Control Policy Type | MANAGED |
| exclude_target_id optional | string | Target ID to Exclude | 112c2fc8c29a449dbfa8681f8f1d7442 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | Policy Category | SCP |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| description | Policy Description | This is an example policy. |
| document | Policy Document | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Service Control Policy Name | MyPolicy |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| source | Policy Creation Subject | ORGANIZATION |
| state | Policy State | ACTIVE |
| type | Service Control Policy Type | MANAGED |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| name optional | array | Service Control Policy Name | M |
| type optional | **** | Service Control Policy Type | MANAGED |
| exclude_target_id optional | string | Target ID to Exclude | 112c2fc8c29a449dbfa8681f8f1d7442 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | Policy Category | SCP |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| description | Policy Description | This is an example policy. |
| document | Policy Document | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Service Control Policy Name | MyPolicy |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| source | Policy Creation Subject | ORGANIZATION |
| state | Policy State | ACTIVE |
| type | Service Control Policy Type | MANAGED |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_type required | **** | Target Type | OU |
| policy_id required | string | Control Policy ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_category optional | **** | Policy Category | SCP |
| name optional | string | Target Name | example-target |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| control_policies | Control Policy ID List | |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| target_name | Target Name | example-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_type required | **** | Target Type | OU |
| policy_id required | string | Control Policy ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_category optional | **** | Policy Category | SCP |
| name optional | string | Target Name | example-target |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| control_policies | Control Policy ID List | |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| target_name | Target Name | example-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_type required | **** | Target Type | OU |
| policy_id required | string | Control Policy ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| policy_category optional | **** | Policy Category | SCP |
| name optional | string | Target Name | example-target |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| control_policies | Control Policy ID List | |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| target_name | Target Name | example-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_ids required | array | Target Account ID List | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| parent_unit_id required | string | Root ID or Organization Unit ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_ids required | array | Target Account ID List | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| parent_unit_id required | string | Root ID or Organization Unit ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_ids required | array | Target Account ID List | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| parent_unit_id required | string | Root ID or Organization Unit ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| organization_id optional | string | Organization ID | o-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_ids required | array | Target Account ID List | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_ids required | array | Target Account ID List | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_account_ids required | array | Target Account ID List | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| organization_id optional | string | Organization ID | o-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_ids required | array | Target Info | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| policy_ids required | array | Control Policy List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| entity required | string | Entity Type | POLICY |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_ids required | array | Target Info | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| policy_ids required | array | Control Policy List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| entity required | string | Entity Type | POLICY |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_ids required | array | Target Info | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| policy_ids required | array | Control Policy List ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| entity required | string | Entity Type | POLICY |
| organization_id optional | string | Organization ID | o-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy 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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| delegation_account_id optional | string | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| name optional | string | Organization Name | My Organization |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn optional | boolean | Control Policy Usage YN | True |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| delegation_account_id optional | string | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| name optional | string | Organization Name | My Organization |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn optional | boolean | Control Policy Usage YN | True |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| delegation_account_id optional | string | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| name optional | string | Organization Name | My Organization |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn optional | boolean | Control Policy Usage YN | True |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| description optional | string | Organization Unit Description | Score Organization Unit |
| name optional | string | Organization Unit Name | score-organization-unit |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| description optional | string | Organization Unit Description | Score Organization Unit |
| name optional | string | Organization Unit Name | score-organization-unit |
| organization_id optional | string | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| description optional | string | Organization Unit Description | Score Organization Unit |
| name optional | string | Organization Unit Name | score-organization-unit |
| organization_id optional | string | Organization ID | o-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| description optional | string | Policy Description | This is an example policy. |
| name optional | string | Service Control Policy Name | MyPolicy |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| description optional | string | Policy Description | This is an example policy. |
| name optional | string | Service Control Policy Name | MyPolicy |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy 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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| description optional | string | Policy Description | This is an example policy. |
| name optional | string | Service Control Policy Name | MyPolicy |
| statement optional | array | Policy Syntax | '{"Action": ["s3:PutObject", "s3:GetObject"], "Condition": "", "Effect": "Allow", "NotAction": [""], "Principal": "", "Resource": ["*"], "Sid": "statement1"}' |
| version optional | string | Policy 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| lazy_policy optional | boolean | Linked Policy Query YN | True |
Responses
| Name | Description | Example |
|---|---|---|
| account | Organization 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| lazy_policy optional | boolean | Linked Policy Query YN | True |
Responses
| Name | Description | Example |
|---|---|---|
| account | Organization 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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_id required | string | Organization Account ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| lazy_policy optional | boolean | Linked Policy Query YN | True |
Responses
| Name | Description | Example |
|---|---|---|
| account | Organization 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| document | Delegation 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_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| document | Delegation 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_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| document | Delegation 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_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| organization_id | Organization ID | o-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| delegation_account_id | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_email | Master Account Email | admin@example.com |
| master_account_id | Master Account ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Organization Name | My Organization |
| root_unit_id | Root Unit ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| srn | Organization SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn | Control Policy Usage YN | True |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| delegation_account_id | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_email | Master Account Email | admin@example.com |
| master_account_id | Master Account ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Organization Name | My Organization |
| root_unit_id | Root Unit ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| srn | Organization SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn | Control Policy Usage YN | True |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| organization_id required | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| delegation_account_id | Delegation Account | 124e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| master_account_email | Master Account Email | admin@example.com |
| master_account_id | Master Account ID | 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Organization Name | My Organization |
| root_unit_id | Root Unit ID | r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r |
| srn | Organization SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| use_scp_yn | Control Policy Usage YN | True |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| organization_unit | Organization 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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| organization_unit | Organization 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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_id required | string | Organization Unit ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| organization_unit | Organization 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | Policy Category | SCP |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| description | Policy Description | This is an example policy. |
| document | Policy Document | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Service Control Policy Name | MyPolicy |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| service_name | Service Name | Organization |
| source | Policy Creation Subject | ORGANIZATION |
| srn | Policy SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2 |
| state | Policy State | ACTIVE |
| type | Service Control Policy Type | MANAGED |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | Policy Category | SCP |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| description | Policy Description | This is an example policy. |
| document | Policy Document | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Service Control Policy Name | MyPolicy |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| service_name | Service Name | Organization |
| source | Policy Creation Subject | ORGANIZATION |
| srn | Policy SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2 |
| state | Policy State | ACTIVE |
| type | Service Control Policy Type | MANAGED |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| policy_id required | string | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| organization_id optional | string | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Service Control Policy ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| category | Policy Category | SCP |
| created_at | Created At | 2025-01-01T00:00:00.000Z |
| created_by | Created By | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | Creator Name | John Doe na |
| description | Policy Description | This is an example policy. |
| document | Policy Document | {‘Statement’: [{‘Action’: [’’], ‘Effect’: ‘Allow’, ‘Resource’: [’’], ‘Sid’: ‘statement1’}], ‘Version’: ‘2024-07-01’} |
| modified_at | Modified At | 2025-01-01T00:00:00.000Z |
| modified_by | Modified By | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | Modifier Name | Alice |
| name | Service Control Policy Name | MyPolicy |
| organization_id | Organization ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| service_name | Service Name | Organization |
| source | Policy Creation Subject | ORGANIZATION |
| srn | Policy SRN | srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2 |
| state | Policy State | ACTIVE |
| type | Service Control Policy Type | MANAGED |
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.
| Version | Status | Not Before |
|---|---|---|
| 1.3 | CURRENT | - |
| 1.2 | DEPRECATED | 20260223 |
| 1.1 | DEPRECATED | 20260223 |
| 1.0 | DEPRECATED | 20260223 |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| request_class optional | string | Request Class | Account |
| service optional | string | Service Name | IAM |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| description optional | string | Description | Virtual Server disk max size |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| max_per_account | Max per Account Value | 1000 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.2 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| request_class optional | string | Request Class | Account |
| service optional | string | Service Name | IAM |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| description optional | string | Description | Virtual Server disk max size |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| max_per_account | Max per Account Value | 1000 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| request_class optional | string | Request Class | Account |
| service optional | string | Service Name | IAM |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| description optional | string | Description | Virtual Server disk max size |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| max_per_account | Max per Account Value | 1000 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| request_class optional | string | Request Class | Account |
| service optional | string | Service Name | IAM |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| description optional | string | Description | Virtual Server disk max size |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| service optional | string | Service Name | Virtual Server |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| requester optional | string | Requester Information | cloud.kim |
| request_class optional | string | Request Class | Account |
| requested_start_at optional | string | Start date of the request | 2024-05-01 |
| requested_end_at optional | string | End date of the request | 2024-05-31 |
| applied_start_at optional | string | Start date of the application | 2024-05-01 |
| applied_end_at optional | string | End date of the application | 2024-05-31 |
| state optional | string | Request State | BEFORE_APPROVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| request_class | Request Class | Account |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| service | Service Name | Virtual Server |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.2 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| service optional | string | Service Name | Virtual Server |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| requester optional | string | Requester Information | cloud.kim |
| request_class optional | string | Request Class | Account |
| requested_start_at optional | string | Start date of the request | 2024-05-01 |
| requested_end_at optional | string | End date of the request | 2024-05-31 |
| applied_start_at optional | string | Start date of the application | 2024-05-01 |
| applied_end_at optional | string | End date of the application | 2024-05-31 |
| state optional | string | Request State | BEFORE_APPROVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| request_class | Request Class | Account |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| service | Service Name | Virtual Server |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| service optional | string | Service Name | Virtual Server |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| requester optional | string | Requester Information | cloud.kim |
| request_class optional | string | Request Class | Account |
| requested_start_at optional | string | Start date of the request | 2024-05-01 |
| requested_end_at optional | string | End date of the request | 2024-05-31 |
| applied_start_at optional | string | Start date of the application | 2024-05-01 |
| applied_end_at optional | string | End date of the application | 2024-05-31 |
| state optional | string | Request State | BEFORE_APPROVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| request_class | Request Class | Account |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| service | Service Name | Virtual Server |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| service optional | string | Service Name | Virtual Server |
| quota_item optional | string | Quota Item Name | QUOTA.REQUEST.COUNT |
| requester optional | string | Requester Information | cloud.kim |
| request_class optional | string | Request Class | Account |
| requested_start_at optional | string | Start date of the request | 2024-05-01 |
| requested_end_at optional | string | End date of the request | 2024-05-31 |
| applied_start_at optional | string | Start date of the application | 2024-05-01 |
| applied_end_at optional | string | End date of the application | 2024-05-31 |
| state optional | string | Request State | BEFORE_APPROVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| request_class | Request Class | Account |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| service | Service Name | Virtual Server |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_quota_id required | string | Account Quota ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| max_per_account | Max per Account Value | 1000 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.2 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_quota_id required | string | Account Quota ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| max_per_account | Max per Account Value | 1000 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_quota_id required | string | Account Quota ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| max_per_account | Max per Account Value | 1000 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| account_quota_id required | string | Account Quota ID | 138c2fc8c29a449dbfa8681f8f1d78e2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Unique identifier for the account | 2b7ed60576ce404bbc734266ff1839a5 |
| account_name | Name of the account | Example Account |
| adjustable | Flag indicating if additional quota is being requested | True |
| applied_value | Modified quota value after changes | 200 |
| approval | Approval | False |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial quota value allocated | 100 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| quota_item | Specific quota item within the resource | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request | Request | False |
| request_class | Request Class | Account |
| resource_type | Type of the resource | account-quota |
| service | Name of the service to which quota applies | Virtual Server |
| srn | Service Resource Name for the quota item | srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 |
| unit | Unit in which the quota value is measured | GB |
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)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | 0c2a06f2f06d42248a6bb88b1a78d4cc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_quota_id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.2 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | 0c2a06f2f06d42248a6bb88b1a78d4cc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_quota_id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.1 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | 0c2a06f2f06d42248a6bb88b1a78d4cc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_quota_id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| request_id required | string | Request ID | 0c2a06f2f06d42248a6bb88b1a78d4cc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_quota_id | Account Quota ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| applied_at | Applied At | 2024-05-17T00:23:17Z |
| applied_value | Applied Value | 200 |
| approval_message | Request message | Quota increase request message. |
| class_value | Value associated with the request class | Global |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Detailed description of the quota item | Maximum disk size for virtual servers in the account |
| free_rate | Free Rate | 10 |
| initial_value | Initial Value | 100 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| quota_item | Quota Item Name | QUOTA.REQUEST.COUNT |
| reduction | Reduction | False |
| request_message | Request message | Quota increase request message. |
| request_value | User Request Value | 300 |
| requester | Requester | cloudkim |
| state | Request State | BEFORE_APPROVE |
| unit | Unit in which the quota value is measured | GB |
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.
| Version | Status | Not Before |
|---|---|---|
| 1.0 | CURRENT | - |
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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Resource Group name | resource-group-1 |
| description required | string | Resource Group description | resource group 1 |
| region optional | string | Region | kr-west1 |
| resource_types optional | array | Resource type list (service:resource_type) | [ |
| tags optional | array | Tag list | '{"key": "tag-key", "value": "tag-value"}' |
Responses
| Name | Description | Example |
|---|---|---|
| resource_group | Resource 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | Tag key (base64 encoded KEY) | dGFnLWtleQ== |
| resource_identifier required | string | Resource ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | Resource type | virtual-server |
| service required | string | Service name | virtualserver |
| region required | string | Region | kr-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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_identifier required | string | Resource ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | Resource type | virtual-server |
| service required | string | Service name | virtualserver |
| region required | string | Region | kr-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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_group_id required | string | Resource Group ID | 1486t61d84b354fb9135cc467owe1346 |
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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids optional | array | Resource 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | Tag key (base64 encoded KEY) | dGFnLWtleQ== |
| srn required | string | SRN (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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | SRN (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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags required | dict | Tag 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_identifier required | string | Resource ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | Resource type | virtual-server |
| service required | string | Service name | virtualserver |
| region required | string | Region | kr-west1 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| key optional | string | Tag key | tag-key |
| value optional | string | Tag value | tag-value |
Responses
| Name | Description | Example |
|---|---|---|
| content | Tag list | |
| count | count | 20 |
| page | page | 0 |
| size | size | 20 |
| sort | sort | [‘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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_group_id required | string | Resource Group ID | 1486t61d84b354fb9135cc467owe1346 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 1234ab567cd64769e8f9g490hi304891 |
| created_at | Created At | 2025-02-27T10:23:43Z |
| created_by | Created By | 7123ke8439734e5789lj355b17ef5473 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| product_name | Product/Service | Virtual Server |
| region | Region | kr-west1 |
| resource_name | Resource name | resource-name-1 |
| resource_type | Resource type | virtual-server |
| resource_type_display_name | Resource type name | Virtual Server |
| service | Service | virtualserver |
| service_name | Service name | Virtual Server |
| srn | SRN | srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496 |
| state | State | Success |
| tags | Tag 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Resource Group ID | 1486t61d84b354fb9135cc467owe1346 |
| name optional | string | Resource Group name | resource-group-1 |
| region optional | string | Region | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Resource Group ID | 1486t61d84b354fb9135cc467owe1346 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Resource Group description | resource group 1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Resource Group name | resource-group-1 |
| region | Region | kr-west1 |
| resource_types | Resource type list | [“resourcemanager:resource-group”, “loggingaudit:trail”] |
| tags | Tag 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Resource ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_name optional | string | Resource name | resource-name-1 |
| service_name optional | string | Service name | Virtual Server |
| resource_type optional | string | Resource type | virtual-server |
| region optional | string | Region | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 1234ab567cd64769e8f9g490hi304891 |
| created_at | Created At | 2025-02-27T10:23:43Z |
| created_by | Created By | 7123ke8439734e5789lj355b17ef5473 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| product_name | Product/Service | Virtual Server |
| region | Region | kr-west1 |
| resource_name | Resource name | resource-name-1 |
| resource_type | Resource type | virtual-server |
| resource_type_display_name | Resource type name | Virtual Server |
| service | Service | virtualserver |
| service_name | Service name | Virtual Server |
| srn | SRN | srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496 |
| state | State | Success |
| tags | Tag 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| key optional | string | Tag key | tag-key |
| value optional | string | Tag value | tag-value |
Responses
| Name | Description | Example |
|---|---|---|
| content | Tag list | |
| count | count | 20 |
| page | page | 0 |
| size | size | 20 |
| sort | sort | [‘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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key optional | string | Tag key | tag-key |
| region optional | string | Region | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| count | Count | 6 |
| keys | Tag 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | Account ID | 1234ab567cd64769e8f9g490hi304891 |
| key optional | string | Tag key | tag-key |
| value optional | string | Tag value | tag-value |
| resource_identifier optional | string | Resource ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type optional | string | Resource type | virtual-server |
| service optional | string | Service name | virtualserver |
| offering optional | string | SCP Offering | dev2 |
| region optional | string | Region | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| key | Tag key | tag-key |
| srn | SRN | srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496 |
| value | Tag value | tag-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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key optional | string | Tag key | tag-key |
| region optional | string | Region | kr-west1 |
| value optional | string | Tag value | tag-value |
Responses
| Name | Description | Example |
|---|---|---|
| count | Count | 6 |
| values | Tag 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_group_id required | string | Resource Group ID | 1486t61d84b354fb9135cc467owe1346 |
| description required | string | Resource Group description | resource group 1 |
| resource_types optional | array | Resource type list (service:resource_type) | [ |
| tags optional | array | Tag 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | Tag key (base64 encoded KEY) | dGFnLWtleQ== |
| resource_identifier required | string | Resource ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | Resource type | virtual-server |
| service required | string | Service name | virtualserver |
| region required | string | Region | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| content | Tag |
9.1.19 - ShowResource
9.1.19.1 - 1.0
scpcli resourcemanager resource show
--srn <value>
Description
get a specific resource
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
Responses
| Name | Description | Example |
|---|---|---|
| resource | Resource |
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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_identifier required | string | Resource ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | Resource type | virtual-server |
| service required | string | Service name | virtualserver |
| region required | string | Region | kr-west1 |
Responses
| Name | Description | Example |
|---|---|---|
| resource | Resource |
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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_group_id required | string | Resource Group ID | 1486t61d84b354fb9135cc467owe1346 |
Responses
| Name | Description | Example |
|---|---|---|
| resource_group | Resource 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | Tag key (base64 encoded KEY) | dGFnLWtleQ== |
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
Responses
| Name | Description | Example |
|---|---|---|
| content | Tag |
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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_identifier required | string | Resource ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | Resource type | virtual-server |
| service required | string | Service name | virtualserver |
| region required | string | Region | kr-west1 |
| tags required | array | Tag 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | Tag key (base64 encoded KEY) | dGFnLWtleQ== |
| resource_identifier required | string | Resource ID | z95fa561-11u3-4frw-962g-3b123123c496 |
| resource_type required | string | Resource type | virtual-server |
| service required | string | Service name | virtualserver |
| region required | string | Region | kr-west1 |
| value required | string | SRN | tag-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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
| tags required | array | Tag 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key required | string | Tag key (base64 encoded KEY) | dGFnLWtleQ== |
| srn required | string | SRN (base64 encoded SRN) | c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== |
| value required | string | SRN | tag-value |
9.1.27 - UpdateTags
9.1.27.1 - 1.0
scpcli resourcemanager tag set
--tags <value>
Description
update tags
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tags required | dict | Tag 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.
| Version | Status | Not Before |
|---|---|---|
| 1.2 | CURRENT | - |
| 1.1 | SUPPORTED | 20260831 |
| 1.0 | DEPRECATED | 20260630 |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| value required | string | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| key required | string | Dimension Key | InstanceId |
| statistic required | string | Statistic - SUM, AVG, MAX, MIN | AVG |
| period required | integer | Period (seconds) | 300 |
| operator required | string | Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE | RANGE |
| namespace_id required | string | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
| name required | string | Alert Name | Alert1 |
| metric_id required | string | Metric ID | d91097ac-0387-4e69-adb2-7b8d453b8db5 |
| level required | string | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| description optional | string | Alert Description | Alert1 Description |
| dimensions optional | array | List of Dimensions | '{"key": "InstanceId", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}' |
| evaluation_count optional | integer | Evaluation Count for the Alert Condition | 3 |
| individual_items optional | array | List of Individual Items | '{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}' |
| lower_bound optional | number | Lower bound for the Alert range operator | 80.0 |
| missing_data_option optional | **** | Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE | BREACHING |
| recipient_ids optional | array | List of User IDs | 1234da92-634a-4f8c-932e-9d650599ab1b |
| tags optional | array | List of Tags | '{"key": "key01", "value": "value01"}' |
| threshold optional | number | Threshold for the Alert Condition (except fro RANGE operator) | 80.0 |
| upper_bound optional | number | Upper bound for the Alert range operator | 90.0 |
| violation_count optional | integer | Violation Count for the Alert Condition | 2 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
10.1.2 - CreateCustomLogEvents
10.1.2.1 - 1.2
scpcli servicewatch logeventcustom create
--resourcelogs <value>
Description
Create Custom log events
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resourcelogs required | array | Resource 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
| Name | Description | Example |
|---|---|---|
| status | Status | success |
10.1.2.2 - 1.1
scpcli servicewatch logeventcustom create
--resourcelogs <value>
Description
Create Custom log events
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resourcelogs required | array | Resource 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
| Name | Description | Example |
|---|---|---|
| status | Status | success |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_stream_name required | string | Log stream name | testls01 |
| log_group_name required | string | Log group name | testlg01 |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | 1bcf39b344ac41cbaf0466ff0d2bebad |
| log_group_value | Log group value | fa6169af200b4d5db229aff384b2a028 |
| log_stream_value | Log stream value | 551513c5182b45beb22eadb634cdccfb |
| requests_per_second | Export log requests per second | 500 |
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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_stream_name required | string | Log stream name | testls01 |
| log_group_name required | string | Log group name | testlg01 |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | Account ID | 1bcf39b344ac41cbaf0466ff0d2bebad |
| log_group_value | Log group value | fa6169af200b4d5db229aff384b2a028 |
| log_stream_value | Log stream value | 551513c5182b45beb22eadb634cdccfb |
| requests_per_second | Export log requests per second | 500 |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| namespace required | string | Namespace | MyCustom/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
| Name | Description | Example |
|---|---|---|
| code | RESPONSE STATUS CODE of Metric | Success |
| message | Message 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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| namespace required | string | Namespace | MyCustom/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
| Name | Description | Example |
|---|---|---|
| code | RESPONSE STATUS CODE of Metric | Success |
| message | Message 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_metrics required | array | The 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
| Name | Description | Example |
|---|
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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_metrics required | array | The 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
| Name | Description | Example |
|---|
10.1.6 - CreateDashboard
10.1.6.1 - 1.2
scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]
Description
Create dashboard
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Dashboard's name | New-Monitoring-Dashboard |
| widgets optional | array | List 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
| Name | Description | Example |
|---|---|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
10.1.6.2 - 1.1
scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]
Description
Create dashboard
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Dashboard's name | New-Monitoring-Dashboard |
| widgets optional | array | List 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
| Name | Description | Example |
|---|---|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Dashboard's name | New-Monitoring-Dashboard |
| widgets optional | array | List 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
| Name | Description | Example |
|---|---|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
| name required | string | Event rule name | Event rule 1 |
| description optional | string | Event rule description | Event rule 1 description |
| event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
| recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
| resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
| srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
| tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| event_rule | Event 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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
| name required | string | Event rule name | Event rule 1 |
| description optional | string | Event rule description | Event rule 1 description |
| event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
| recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
| resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
| srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
| tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| event_rule | Event 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
| name required | string | Event rule name | Event rule 1 |
| description optional | string | Event rule description | Event rule 1 description |
| event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
| recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
| resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
| srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
| tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| event_rule | Event 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| retention_period required | integer | Log group retention period | 365 |
| name required | string | Log group name | testlg01 |
| tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| log_group | Log 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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| retention_period required | integer | Log group retention period | 365 |
| name required | string | Log group name | testlg01 |
| tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| log_group | Log 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| retention_period required | integer | Log group retention period | 365 |
| name required | string | Log group name | testlg01 |
| tags optional | array | List of Tags | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| log_group | Log 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| name required | string | Log stream name | testls01 |
Responses
| Name | Description | Example |
|---|---|---|
| log_stream | Log 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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| name required | string | Log stream name | testls01 |
Responses
| Name | Description | Example |
|---|---|---|
| log_stream | Log 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| name required | string | Log stream name | testls01 |
Responses
| Name | Description | Example |
|---|---|---|
| log_stream | Log stream |
10.1.10 - DeleteAlerts
10.1.10.1 - 1.2
scpcli servicewatch alert delete-bulk
--ids <value>
Description
Delete Alerts
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Alert IDs | 0ad6da92-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
10.1.11.2 - 1.1
scpcli servicewatch dashboard delete
--dashboard_ids <value>
Description
Delete bulk dashboards
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_ids required | array | List of dashboard IDs | b48e730a70e74f6aa3d2555000b5c22b |
10.1.12 - DeleteEventRules
10.1.12.1 - 1.2
scpcli servicewatch eventrule delete-bulk
--ids <value>
Description
Delete Event rules.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Event rule IDs | 66d77b4e32d04558b2382b1d14765d86 |
10.1.12.2 - 1.1
scpcli servicewatch eventrule delete-bulk
--ids <value>
Description
Delete Event rules.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Event rule IDs | 66d77b4e32d04558b2382b1d14765d86 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Event rule IDs | 66d77b4e32d04558b2382b1d14765d86 |
10.1.13 - DeleteLogGroups
10.1.13.1 - 1.2
scpcli servicewatch loggroup delete-bulk
--ids <value>
Description
Delete Log groups.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Log group IDs | 602b39cb1d6b4b7fb0f18de43a4c689c |
10.1.13.2 - 1.1
scpcli servicewatch loggroup delete-bulk
--ids <value>
Description
Delete Log groups.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Log group IDs | 602b39cb1d6b4b7fb0f18de43a4c689c |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| ids required | array | List of Log group IDs | 602b39cb1d6b4b7fb0f18de43a4c689c |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| ids required | array | List of Log stream IDs | b0fc99a46a2c44b8b22739b130853dd8 |
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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| ids required | array | List of Log stream IDs | b0fc99a46a2c44b8b22739b130853dd8 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| ids required | array | List of Log stream IDs | b0fc99a46a2c44b8b22739b130853dd8 |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
| height optional | integer | Chart Image Height(pixels) | 400 |
| timezone optional | string | Timezone | UTC |
| title optional | string | Chart Title | Virtual Server Metric Chart |
| width optional | integer | Chart Image Width(pixels) | 600 |
Responses
| Name | Description | Example |
|---|
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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
| height optional | integer | Chart Image Height(pixels) | 400 |
| timezone optional | string | Timezone | UTC |
| title optional | string | Chart Title | Virtual Server Metric Chart |
| width optional | integer | Chart Image Width(pixels) | 600 |
Responses
| Name | Description | Example |
|---|
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“color”: “#0000ff”, “dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
| height optional | integer | Chart Image Height(pixels) | 400 |
| timezone optional | string | Timezone | UTC |
| title optional | string | Chart Title | Virtual Server Metric Chart |
| width optional | integer | Chart Image Width(pixels) | 600 |
Responses
| Name | Description | Example |
|---|
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | name:asc or modified_at:desc |
| name optional | string | Dashboard's name | MyProd |
| name_like optional | string | Wildcard Search for Dashboard Names | MyProd |
| favorite_enabled optional | boolean | Whether it is a favorite dashboard | True |
| type optional | string | Dashboard type | Custom |
| service_code optional | string | Associated service code | virtualserver |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| created_at | Created date time | |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| name | Dashboard’s name | Production-Web-Servers |
| type | Dashboard type | Custom |
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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | name:asc or modified_at:desc |
| name optional | string | Dashboard's name | MyProd |
| name_like optional | string | Wildcard Search for Dashboard Names | MyProd |
| favorite_enabled optional | boolean | Whether it is a favorite dashboard | True |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| created_at | Created date time | |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| name | Dashboard’s name | Production-Web-Servers |
| type | Dashboard type | Custom |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | name:asc or modified_at:desc |
| name optional | string | Dashboard's name | MyProd |
| name_like optional | string | Wildcard Search for Dashboard Names | MyProd |
| favorite_enabled optional | boolean | Whether it is a favorite dashboard | True |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| created_at | Created date time | |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| name | Dashboard’s name | Production-Web-Servers |
| type | Dashboard type | Custom |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ids optional | array | List of Log group IDs | 6 |
| name optional | string | Log group name | testlg01 |
| retention_periods optional | array | List of Log group retention periods | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Log group ID | bce52822147744b4afe0187164caa2e8 |
| account_id | Account ID | 1bcf39b344ac41cbaf0466ff0d2bebad |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| modified_at | Modified date time | |
| modified_by | Modifier ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| name | Log group name | testlg01 |
| retention_period | Log group retention period | 365 |
| retention_period_name | Log group retention period name | 1 year |
| status | Log group status | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ids optional | array | List of Log group IDs | 6 |
| name optional | string | Log group name | testlg01 |
| retention_periods optional | array | List of Log group retention periods | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Log group ID | bce52822147744b4afe0187164caa2e8 |
| account_id | Account ID | 1bcf39b344ac41cbaf0466ff0d2bebad |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| modified_at | Modified date time | |
| modified_by | Modifier ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| name | Log group name | testlg01 |
| retention_period | Log group retention period | 365 |
| retention_period_name | Log group retention period name | 1 year |
| status | Log group status | ACTIVE |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ids optional | array | List of Log group IDs | 6 |
| name optional | string | Log group name | testlg01 |
| retention_periods optional | array | List of Log group retention periods | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Log group ID | bce52822147744b4afe0187164caa2e8 |
| account_id | Account ID | 1bcf39b344ac41cbaf0466ff0d2bebad |
| created_at | Created date time | |
| created_by | Creator ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| modified_at | Modified date time | |
| modified_by | Modifier ID | f4b8a4c4017f4f8d8399f0c02582ae47 |
| name | Log group name | testlg01 |
| retention_period | Log group retention period | 365 |
| retention_period_name | Log group retention period name | 1 year |
| status | Log group status | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
Responses
| Name | Description | Example |
|---|---|---|
| display_name | Metric Display Name | Virtual Server |
| status | ||
| values | List 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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
Responses
| Name | Description | Example |
|---|---|---|
| display_name | Metric Display Name | Virtual Server |
| status | ||
| values | List 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| statistic_type required | string | Metric Statistics Type | AVG |
| start required | integer | Metric Start Time - Unix Timestamp | 1640995200 |
| period required | integer | Statistic Period | 300 |
| metrics required | array | ```’{“dimensions”: [{“key”: “VolumeID”, “value”: “45fbde15-cdd2-4891-be31-4a9de75fccda”}], “display_name”: “Virtual Server | |
| end required | integer | Metric End Time - Unix Timestamp | 1640995440 |
Responses
| Name | Description | Example |
|---|---|---|
| display_name | Metric Display Name | Virtual Server |
| status | ||
| values | List 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| metric_name optional | string | Metric Name | CPU Usage/Core[Basic] |
| namespaces optional | array | List of Namespace | '{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}' |
| resource_id optional | string | Resource ID | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| resource_name optional | string | Resource Name | VirtualServer01 |
| tags optional | array | List of Tags | '{"key": "key01", "value": "value01"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
| dimensions | ||
| name | Namespace | Virtual 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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| metric_name optional | string | Metric Name | CPU Usage/Core[Basic] |
| namespaces optional | array | List of Namespace | '{"dimensions": "[[\"resource_id\"]]", "name": "Virtual Server"}' |
| resource_id optional | string | Resource ID | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| resource_name optional | string | Resource Name | VirtualServer01 |
| tags optional | array | List of Tags | '{"key": "key01", "value": "value01"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
| dimensions | ||
| name | Namespace | Virtual 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| metric_name optional | string | Metric Name | CPU Usage/Core[Basic] |
| namespaces optional | array | List of Namespace | '{"dimensions": "[\"resource_id\"]", "name": "Virtual Server"}' |
| resource_id optional | string | Resource ID | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| resource_name optional | string | Resource Name | VirtualServer01 |
| tags optional | array | List of Tags | '{"key": "key01", "value": "value01"}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
| dimensions | ||
| name | Namespace | Virtual 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
| value required | string | Dimension Value | 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 |
| key required | string | Dimension Key | InstanceId |
| statistic required | string | Statistic - SUM, AVG, MAX, MIN | AVG |
| period required | integer | Period (seconds) | 300 |
| operator required | string | Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE | RANGE |
| namespace_id required | string | Namespace ID | d583a229-9766-4eb8-96c4-ec389902ba3d |
| metric_id required | string | Metric ID | d91097ac-0387-4e69-adb2-7b8d453b8db5 |
| level required | string | Alert Level - HIGH, MIDDLE, LOW | HIGH |
| dimensions optional | array | List of Dimensions | '{"key": "InstanceId", "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"}' |
| evaluation_count optional | integer | Evaluation Count for the Alert Condition | 3 |
| individual_items optional | array | List of Individual Items | '{"key": "VolumeID", "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"}' |
| lower_bound optional | number | Lower bound for the Alert range operator | 80.0 |
| missing_data_option optional | **** | Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE | BREACHING |
| threshold optional | number | Threshold for the Alert Condition (except fro RANGE operator) | 80.0 |
| upper_bound optional | number | Upper bound for the Alert range operator | 90.0 |
| violation_count optional | integer | Violation Count for the Alert Condition | 2 |
Responses
| Name | Description | Example |
|---|---|---|
| key | Dimension Key | InstanceId |
| value | Dimension Value | 10bf5d24-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
| activated_yn required | string | Whether the Alert is activated or not | Y |
Responses
| Name | Description | Example |
|---|---|---|
| id | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
| activated_yn | Whether the Alert is activated or not | Y |
| modified_at | Modified date time | 2026-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
| description optional | string | Alert Description | Alert1 Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
| description | Alert Description | Alert1 Description |
| modified_at | Modified date time | 2026-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| name optional | string | Dashboard's name | Renamed-Dashboard |
| widgets optional | array | List 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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| name optional | string | Dashboard's name | Renamed-Dashboard |
| widgets optional | array | List 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| name optional | string | Dashboard's name | Renamed-Dashboard |
| widgets optional | array | List 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| event_rule_id required | string | Event rule ID | b73f95c698f540dab18860f72fafd03f |
| service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
| active_yn optional | **** | Whether the Event rule is active | Y |
| description optional | string | Event rule description | Event rule 1 description |
| event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
| none_attributes optional | array | List of attributes to assign to None | description |
| recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
| resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
| srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
Responses
| Name | Description | Example |
|---|---|---|
| event_rule | Event 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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| event_rule_id required | string | Event rule ID | b73f95c698f540dab18860f72fafd03f |
| service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
| active_yn optional | **** | Whether the Event rule is active | Y |
| description optional | string | Event rule description | Event rule 1 description |
| event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
| none_attributes optional | array | List of attributes to assign to None | description |
| recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
| resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
| srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
Responses
| Name | Description | Example |
|---|---|---|
| event_rule | Event 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| event_rule_id required | string | Event rule ID | b73f95c698f540dab18860f72fafd03f |
| service_id required | string | Service ID | 2778de83d7e247609445bbd570a4eba9 |
| active_yn optional | **** | Whether the Event rule is active | Y |
| description optional | string | Event rule description | Event rule 1 description |
| event_ids optional | array | List of Event IDs | 014cb88ca2a9420e840d5c9ac16cac89 |
| none_attributes optional | array | List of attributes to assign to None | description |
| recipient_ids optional | array | Notification recipient IDs | 947c6a8559434505b28a5e21fff463d0 |
| resource_type_id optional | string | Resource type ID | 596bf16709e84e27b7df397bf59b877c |
| srn_list optional | array | List of SDS cloud Resource Names | srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a |
Responses
| Name | Description | Example |
|---|---|---|
| event_rule | Event 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| retention_period required | integer | Log group retention period | 365 |
Responses
| Name | Description | Example |
|---|---|---|
| log_group | Log 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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| retention_period required | integer | Log group retention period | 365 |
Responses
| Name | Description | Example |
|---|---|---|
| log_group | Log 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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
| retention_period required | integer | Log group retention period | 365 |
Responses
| Name | Description | Example |
|---|---|---|
| log_group | Log 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Responses
| Name | Description | Example |
|---|---|---|
| download_link | URL to download agent | https://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)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Responses
| Name | Description | Example |
|---|---|---|
| download_link | URL to download agent | https://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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| id required | string | Alert ID | 0ad6da92-634a-4f8c-932e-9d650599ab1e |
Responses
| Name | Description | Example |
|---|---|---|
| key | Dimension Key | InstanceId |
| value | Dimension Value | 10bf5d24-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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
Responses
| Name | Description | Example |
|---|---|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
10.1.28.2 - 1.1
scpcli servicewatch dashboard show
--dashboard_id <value>
Description
Show dashboard
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
Responses
| Name | Description | Example |
|---|---|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
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.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| dashboard_id required | string | Dashboard's unique ID | b48e730a70e74f6aa3d2555000b5c22b |
Responses
| Name | Description | Example |
|---|---|---|
| id | Widget’s unique ID | 75da70a1a4fb486ab0282cf90693ec3c |
| dashboard_id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| height | Widget’s height | 1 |
| order | Widget’s order in the dashboard | 1 |
| properties | Widget’s detailed properties | |
| type | Widget type | metric |
| width | Widget’s width | 1 |
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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| event_rule_id required | string | Event rule ID | b73f95c698f540dab18860f72fafd03f |
Responses
| Name | Description | Example |
|---|---|---|
| event_rule | Event 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
Responses
| Name | Description | Example |
|---|---|---|
| log_group | Log 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)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| log_stream_id required | string | Log stream ID | b0fc99a46a2c44b8b22739b130853dd8 |
| log_group_id required | string | Log group ID | bce52822147744b4afe0187164caa2e8 |
Responses
| Name | Description | Example |
|---|---|---|
| log_stream | Log 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.
| Version | Status | Not Before |
|---|---|---|
| 1.0 | CURRENT | - |
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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| title optional | string | title | VM usage inquiry |
| state optional | string | state | CLOSED |
| inquiry_type optional | string | inquiry type | General Inquiry - Account and connection inquiry |
| region_id optional | string | region id | kr-west1 |
| created_at optional | string | created at | 2024-06-01T00:12:57.000000Z |
| filter_inquiry_codes optional | string | filter inquiry codes | FL01,FL02 |
| filter_states optional | string | filter states | TODO,INPROGRESS |
Responses
| Name | Description | Example |
|---|---|---|
| id | id | sr-240530-00028-nuri |
| account_id | account id | 2010571da2f7458e97c3b881b2362b72 |
| closed_at | closed at | 2024-06-27T08:12:57.000000Z |
| contents | contents | VM usage inquiry |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| files | file list | |
| inquiry_code | inquiry code | G01 |
| inquiry_type | inquiry type | General Inquiry - Account and connection inquiry |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region_id | region id | kr-west1 |
| resource_name | resource name | lb1 |
| service_category | service category | Networking |
| service_item | service item | Load Balancer |
| state | state | CLOSED |
| title | title | VM 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| filter_operation_type_ids optional | string | operation type ids | e8fea87728164808860ad81c6ce779b6 |
| filter_service_item_ids optional | string | service item id list | VIRTUAL_SERVER,LOAD_BALANCER |
| filter_title optional | string | title | Virtual Server operation related |
| filter_states optional | string | filter states | REQUESTING,CLOSED |
| from_created_at optional | string | from created at | 2024-07-01T00:00:00Z |
| to_created_at optional | string | to created at | 2024-07-05T23:59:59Z |
| operation_type optional | string | operation type | Placement Group Set Up Request |
| service_item_name optional | string | service item | Load Balancer |
| title optional | string | title | Virtual Server operation related |
| state optional | string | state | REQUESTING |
Responses
| Name | Description | Example |
|---|---|---|
| id | id | 007d8cc7d60c4b26bb5a833b06686db3 |
| account_id | account id | 2010571da2f7458e97c3b881b2362b72 |
| account_name | account name | dev_project |
| closed_at | closed at | 2024-06-27T08:12:57.000000Z |
| contents | contents | I need assistance with working with Virtual Server. |
| created_at | created at | 2024-06-01T00:12:57.000000Z |
| created_by | created by | e3bff0c980dc41b2b6f3ac080b6d3ba0 |
| created_by_name | created by name and email | KimSamSung(test@samsung.com) |
| files | file list | |
| iops_result | iops result | Processing completed. |
| iops_sr_id | iops sr id | SR0002834921 |
| modified_at | modified at | 2024-06-11T00:12:57.000000Z |
| modified_by | modified by | e3bff0c980dc41b2b6f3ac080b6d3ba0 |
| operation_type | operation type | Placement Group Set Up Request |
| region | region | kr-west1 |
| service_category_name | service category | Networking |
| service_item_name | service item | Load Balancer |
| state | state | ACTIVE |
| template_id | template id | e8fea87728164808860ad81c6ce779b6 |
| title | title | Virtual 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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| inquiry_id required | string | id | sr-240530-00028-nuri |
Responses
| Name | Description | Example |
|---|---|---|
| id | id | File-008ccb7ff65244689dacd605fafec92f |
| file_name | name | test.txt |
| size | size | 298426 |
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)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_request_id required | string | id | 007d8cc7d60c4b26bb5a833b06686db3 |
Responses
| Name | Description | Example |
|---|---|---|
| id | id | File-008ccb7ff65244689dacd605fafec92f |
| file_name | name | test.txt |
| size | size | 298426 |