This is the multi-page printable view of this section. Click here to print.
CLIs
1 - Acquire temporary role credential
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 |
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 - Acquire temporary role credential from SAML Assertion
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.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 |
3 - Create new Signature based on Session Token
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 |
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 |