Security Token Service(STS)

Obtain temporary identity credentials for the role played - AssumeRole


Obtain temporary identity credentials for the role played


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is AssumeRole.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RoleUrnstringThe URN of the RAM role to be assumed.Yes
RoleSessionNamestringRole session name. The format allows 1-64 characters composed of letters, numbers, underscores (_), hyphens (-), and English periods (.).Yes
DurationSecondsintToken validity period, unit: seconds. The minimum value is 900, and the maximum value is limited by the maximum session time configured for the role.No
PolicystringAn additional permission policy added for the STS Token, further limiting the permissions of the STS Token.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
CredentialsCredentialsAccess Token.No

Data Model


Field NameTypeDescription InformationRequired
SecurityTokenstringSecurity Token.Yes
AccessKeyIdstringKey ID.Yes
AccessKeySecretstringSecret Key.Yes
ExpirationstringToken expiration time (UTC time).Yes


Request Example

Response Example

  "Action": "AssumeRoleResponse",
  "Credentials": {},
  "RetCode": 0
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.