通过委托或者信任委托获取临时安全凭证 -j9九游会登录
功能介绍
通过委托或者信任委托获取临时安全凭证,临时安全凭证可用于对云资源发起访问。
调试
您可以在中调试该接口,支持自动认证鉴权。api explorer可以自动生成sdk代码示例,并提供sdk代码示例调试功能。
授权信息
账号根用户具备所有api的调用权限,如果使用账号下的iam用户调用当前api,该iam用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型(*为必须) |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
sts:agencies:assume |
write |
agency * |
g:resourcetag/ |
- |
|
|
- |
|
uri
post /v5/agencies/assume
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-security-token |
否 |
string |
通过临时安全凭证调用接口时,需要提供“x-security-token”http头,取值为临时安全凭证的security_token字段。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
duration_seconds |
否 |
integer |
获得的临时安全凭证的有效时间(单位秒)。请注意,该时间需要小于委托本身设置的最大会话持续时间,同时在携带x-security-token的header头时该时间不能超过3600秒。 最小值:900 最大值:43200 缺省值:3600 |
|
external_id |
否 |
string |
外部id,防止混淆代理人问题。 最小长度:2 最大长度:1224 |
|
policy |
否 |
string |
自定义策略,限制本次会话获得的临时安全凭证的权限范围不会超过该自定义策略指定的权限。 最小长度:2 最大长度:2048 |
|
policy_ids |
否 |
array of strings |
预置策略列表,限制本次会话获得的临时安全凭证的权限范围不会超过该预置策略指定的权限。 最大长度:64 |
|
agency_urn |
是 |
string |
目标委托的urn。 最大长度:1500 |
|
agency_session_name |
是 |
string |
委托会话的会话名。 最小长度:2 最大长度:128 |
|
serial_number |
否 |
string |
调用者绑定的mfa设备的序列号。 最小长度:9 最大长度:256 |
|
token_code |
否 |
string |
调用者绑定的mfa设备上的6位数字码。 最小长度:6 最大长度:6 |
|
source_identity |
否 |
string |
调用链里最初调用者所声明的身份。 最小长度:2 最大长度:64 |
|
tags |
否 |
array of tagdto objects |
自定义标签列表。 |
|
transitive_tag_keys |
否 |
array of strings |
随着临时安全凭证调用链持续透传的标签键列表。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
key |
是 |
string |
标签键。 最小长度:1 最大长度:128 |
|
value |
是 |
string |
标签值,取值可以为空字符串,不可以为null。 最小长度:0 最大长度:255 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
source_identity |
string |
调用链里最初调用者所声明的身份。 最小长度:2 最大长度:64 |
|
assumed_agency |
assumedagencydto object |
目标委托信息。 |
|
credentials |
credentialsdto object |
生成的临时安全凭证。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
urn |
string |
目标委托的urn。 最大长度:1500 |
|
id |
string |
目标委托的唯一标志,包含了委托id和委托会话名称信息。 最大长度:256 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
access_key_id |
string |
临时安全凭证的ak。 最小长度:20 最大长度:20 |
|
expiration |
string |
临时安全凭证的失效时间。 |
|
secret_access_key |
string |
临时安全凭证的sk。 最小长度:40 最大长度:40 |
|
security_token |
string |
临时安全凭证的security_token。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
string |
错误码。 |
|
error_msg |
string |
错误信息。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
string |
错误码。 |
|
error_msg |
string |
错误信息。 |
|
encoded_authorization_message |
string |
加密后的认证失败信息,可以通过sts5解密接口进行解密。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
string |
错误码。 |
|
error_msg |
string |
错误信息。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
string |
错误码。 |
|
error_msg |
string |
错误信息。 |
请求示例
通过账号27680d67da6b47eb82d00a1a118be145下的委托y0yfcqyjgo获取临时安全凭证。
post https://{endpoint}/v5/agencies/assume
{
"duration_seconds" : 3600,
"agency_urn" : "iam::27680d67da6b47eb82d00a1a118be145:agency:y0yfcqyjgo",
"agency_session_name" : "session1"
}
响应示例
状态码:200
请求成功。
{
"assumed_agency" : {
"urn" : "sts::{account_id}::assumed-agency:{agency_name}/{agency_session_name}",
"id" : "{agency_id}:{agency_session_name}"
},
"credentials" : {
"access_key_id" : "hstano...xbs55jlj3",
"secret_access_key" : "eowcqrr...sccw4whkt2axkwar",
"security_token" : "hqpjbi1xxxxxx...xxxxxkbhbba0tq==",
"expiration" : "2022-09-07t03:27:51.158z"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
请求体异常。 |
|
403 |
没有操作权限。 |
|
404 |
未找到对应资源。 |
|
500 |
服务端异常。 |
错误码
请参见错误码。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨