This is the multi-page printable view of this section. Click here to print.
Platform
- 1: Product
- 1.1: CLIs
- 1.1.1: List Product Categories
- 1.1.1.1: 1.0
- 1.1.2: List Products
- 1.1.2.1: 1.0
- 1.1.3: Show Product
- 1.1.3.1: 1.0
- 1.1.4: Show Product category
- 1.1.4.1: 1.0
- 2: STS
1 - Product
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 PRODUCT 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 | - |
1.1 - CLIs
1.1.1 - List Product Categories
1.1.1.1 - 1.0
scpcli product product categories list
[--limit <value>]
[--page <value>]
[--display_name <value>]
[--display_name_ko <value>]
[--is_exposed_menu <value>]
[--created_by <value>]
[--modified_by <value>]
[--created_start_date <value>]
[--created_end_date <value>]
[--modified_start_date <value>]
[--modified_end_date <value>]
[--sort <value>]
Description
List product categories
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | LIMIT | 10 |
| page optional | integer | Page | 1 |
| display_name optional | array | Product Category Name | N |
| display_name_ko optional | array | Product Category Name | N |
| is_exposed_menu optional | array | Product Category Menu Exposed Status | T |
| created_by optional | string | Created by | 김삼성 |
| modified_by optional | string | Modified by | 김삼성 |
| created_start_date optional | string | Created start date | 2024-01-01T00:00:00 |
| created_end_date optional | string | Created end date | 2024-01-01T00:00:00 |
| modified_start_date optional | string | Modified start date | 2024-01-01T00:00:00 |
| modified_end_date optional | string | Modified end date | 2024-01-01T00:00:00 |
| sort optional | string | Sort | created_at:asc |
Responses
| Name | Description | Example |
|---|---|---|
| category_id | Product Category ID | NETWORKING |
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product Category Name | Networking |
| display_name_ko | Product Category Name | Networking |
| icon_file_id | Icon File ID | c1d5c1f63bf24f73b32c37f6f7b50310 |
| is_exposed_menu | Product Category Menu Exposed Status | True |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| seq | Seq | 9 |
| service_group_color_id | Service Group Color | ffff00 |
1.1.2 - List Products
1.1.2.1 - 1.0
scpcli product product list
[--limit <value>]
[--page <value>]
[--product_category_id <value>]
[--product_id <value>]
[--display_name <value>]
[--display_name_ko <value>]
[--kind <value>]
[--created_start_date <value>]
[--created_end_date <value>]
[--modified_start_date <value>]
[--modified_end_date <value>]
[--sort <value>]
Description
List products.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| limit optional | integer | LIMIT | 10 |
| page optional | integer | Page | 1 |
| product_category_id optional | array | Product Category ID | N |
| product_id optional | array | Product ID | V |
| display_name optional | array | Product name | V |
| display_name_ko optional | array | Product name | V |
| kind optional | array | Product Kind | P |
| created_start_date optional | string | Created start date | 2024-01-01T00:00:00 |
| created_end_date optional | string | Created end date | 2024-01-01T00:00:00 |
| modified_start_date optional | string | Modified start date | 2024-01-01T00:00:00 |
| modified_end_date optional | string | Modified end date | 2024-01-01T00:00:00 |
| sort optional | string | Sort | created_at:asc |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product name | VPC |
| display_name_ko | Product name | VPC |
| kind | Product Kind | PRODUCT |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| product_category_id | Product Category ID | NETWORKING |
| product_category_name | Product Category Name | Networking |
| product_id | Product ID | VPC |
1.1.3 - Show Product
1.1.3.1 - 1.0
scpcli product product show
--product_id <value>
Description
Show product.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| product_id required | string | Product ID | VPC |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product name | VPC |
| display_name_ko | Product name | VPC |
| kind | Product Kind | PRODUCT |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| product_category_id | Product Category ID | NETWORKING |
| product_category_name | Product Category Name | Networking |
| product_id | Product ID | VPC |
1.1.4 - Show Product category
1.1.4.1 - 1.0
scpcli product product category show
--category_id <value>
Description
Show product category.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| category_id required | string | Product Category ID | NETWORKING |
Responses
| Name | Description | Example |
|---|---|---|
| category_id | Product Category ID | NETWORKING |
| created_at | Created date | 2024-01-01T00:00:00 |
| created_by | Created by | 5cada9f6afa049418c4f18c0c4859202 |
| display_name | Product Category Name | Networking |
| display_name_ko | Product Category Name | Networking |
| icon_file_id | Icon File ID | c1d5c1f63bf24f73b32c37f6f7b50310 |
| is_exposed_menu | Product Category Menu Exposed Status | True |
| modified_at | Modified date | 2024-01-01T00:00:00 |
| modified_by | Modified by | 5cada9f6afa049418c4f18c0c4859202 |
| seq | Seq | 9 |
| service_group_color_id | Service Group Color | ffff00 |
2 - STS
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.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20260531 |
2.1 - CLIs
2.1.1 - Acquire temporary role credential
2.1.1.1 - 1.1
scpcli sts sts assume role
--role_session_name <value>
--role_indicator <value>
[--duration_seconds <value>]
Description
Acquire temporary role credential
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_session_name required | string | Role Session Name | - |
| role_indicator required | string | Identifier of the role to assume. [offering:account_id:role_name] | dev2:afd580f490394896a6bceabf77683c6bd:role_name |
| duration_seconds optional | integer | Duration of seconds of the role session | - |
Responses
| Name | Description | Example |
|---|---|---|
| assumed_role_user | Assumed Role ID | |
| credentials | Temporary Credentials |
2.1.1.2 - 1.0
scpcli sts sts assume role
--role_session_name <value>
--role_indicator <value>
[--duration_seconds <value>]
Description
Acquire temporary role credential
State ACTIVE (DEPRECATED)
Deprecated 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 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| role_session_name required | string | Role Session Name | - |
| role_indicator required | string | Identifier of the role to assume. [offering:account_id:role_name] | dev2:afd580f490394896a6bceabf77683c6bd:role_name |
| duration_seconds optional | integer | Duration of seconds of the role session | - |
Responses
| Name | Description | Example |
|---|---|---|
| assumed_role_user | Assumed Role ID | |
| credentials | Temporary Credentials |
2.1.2 - Acquire temporary role credential from SAML Assertion
2.1.2.1 - 1.1
scpcli sts sts assume role with saml
--saml_assertion <value>
--role_indicator <value>
--principal_indicator <value>
[--duration_seconds <value>]
Description
Acquire temporary role credential from SAML Assertion
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_assertion required | string | SAML Assertion | - |
| role_indicator required | string | Identifier of the role to assume. [offering:account_id:role_name] | dev2:afd580f490394896a6bceabf77683c6bd:role_name |
| principal_indicator required | string | SAML Provider Indicator | dev2:afd580f490394896a6bceabf77683c6bd:principal_name |
| duration_seconds optional | integer | Duration of seconds of the role session | - |
Responses
| Name | Description | Example |
|---|---|---|
| assumed_role_user | Assumed Role ID | |
| audience | Recipient Value | |
| credentials | Temporary Credentials | |
| issuer | Issuer Value | |
| subject | Name ID Value | |
| subject_type | Name ID Format |
2.1.2.2 - 1.0
scpcli sts sts assume role with saml
--saml_assertion <value>
--role_indicator <value>
--principal_indicator <value>
[--duration_seconds <value>]
Description
Acquire temporary role credential from SAML Assertion
State ACTIVE (DEPRECATED)
Deprecated 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 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| saml_assertion required | string | SAML Assertion | - |
| role_indicator required | string | Identifier of the role to assume. [offering:account_id:role_name] | dev2:afd580f490394896a6bceabf77683c6bd:role_name |
| principal_indicator required | string | SAML Provider Indicator | dev2:afd580f490394896a6bceabf77683c6bd:principal_name |
| duration_seconds optional | integer | Duration of seconds of the role session | - |
Responses
| Name | Description | Example |
|---|---|---|
| assumed_role_user | Assumed Role ID | |
| audience | Recipient Value | |
| credentials | Temporary Credentials | |
| issuer | Issuer Value | |
| subject | Name ID Value | |
| subject_type | Name ID Format |
2.1.3 - Create new Signature based on Session Token
2.1.3.1 - 1.1
scpcli sts sts object store authorization
--x_amz_date <value>
--x_amz_content_sha256 <value>
--url <value>
--method <value>
[--region <value>]
[--service <value>]
Description
Create new Signature based on Session Token
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| x_amz_date required | string | AMZ Date | - |
| x_amz_content_sha256 required | string | AMZ Content SHA256 | - |
| url required | string | The URL of the request | - |
| method required | string | HTTP Method | - |
| region optional | string | Region | - |
| service optional | string | Service | - |
Responses
| Name | Description | Example |
|---|---|---|
| Authorization | Authorization Header |
2.1.3.2 - 1.0
scpcli sts sts object store authorization
--x_amz_date <value>
--x_amz_content_sha256 <value>
--url <value>
--method <value>
[--region <value>]
[--service <value>]
Description
Create new Signature based on Session Token
State ACTIVE (DEPRECATED)
Deprecated 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 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| x_amz_date required | string | AMZ Date | - |
| x_amz_content_sha256 required | string | AMZ Content SHA256 | - |
| url required | string | The URL of the request | - |
| method required | string | HTTP Method | - |
| region optional | string | Region | - |
| service optional | string | Service | - |
Responses
| Name | Description | Example |
|---|---|---|
| Authorization | Authorization Header |