创建信任委托 -j9九游会登录
功能介绍
该接口可以用于创建信任委托。
调试
您可以在中调试该接口,支持自动认证鉴权。api explorer可以自动生成sdk代码示例,并提供sdk代码示例调试功能。
授权信息
账号根用户具备所有api的调用权限,如果使用账号下的iam用户调用当前api,该iam用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型(*为必须) |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
iam:agencies:createv5 |
write |
agency * |
- |
- |
- |
uri
post /v5/agencies
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
agency_name |
是 |
string |
信任委托名称,长度为1到64个字符,只包含字母、数字、"_"、" "、"="、","、"."、"@"和"-"的字符串。 |
|
path |
否 |
string |
资源路径,默认为空串。由若干段字符串拼接而成,每段先包含一个或多个字母、数字、"."、","、" "、"@"、"="、"_"或"-",并以"/"结尾,例如"foo/bar/"。 |
|
trust_policy |
是 |
string |
信任委托信任策略的策略文档的json格式。下面的字符= < > ( ) |是语法中的特殊字符,不包含在信任策略中。 问号?表示元素是可选的。例如sid_block?。 竖线|表示可选项,括号定义了可选项的范围。例如("allow" | "deny")。 当一个元素允许多个值时,使用重复值,以及...表示。例如[ 下面的递归文法描述了信任策略的语法: policy = {
|
|
max_session_duration |
否 |
integer |
信任委托最大会话时长,默认为3600秒,取值范围为[3600,43200]。 |
|
description |
否 |
string |
信任委托描述信息,默认为空串,字符串最大长度为1000。 最大长度:1000 |
响应参数
状态码:201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
agency |
trustagency object |
信任委托。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
urn |
string |
统一资源名称。 |
|
trust_policy |
string |
信任委托信任策略的策略文档的json格式。下面的字符= < > ( ) |是语法中的特殊字符,不包含在信任策略中。 问号?表示元素是可选的。例如sid_block?。 竖线|表示可选项,括号定义了可选项的范围。例如("allow" | "deny")。 当一个元素允许多个值时,使用重复值,以及...表示。例如[ 下面的递归文法描述了信任策略的语法: policy = {
|
|
created_at |
string |
信任委托创建时间。 |
|
description |
string |
信任委托描述信息。 |
|
max_session_duration |
integer |
信任委托最大会话时长,默认为3600秒,取值范围为[3600,43200]。 |
|
path |
string |
资源路径,默认为空串。由若干段字符串拼接而成,每段先包含一个或多个字母、数字、"."、","、" "、"@"、"="、"_"或"-",并以"/"结尾,例如"foo/bar/"。 |
|
agency_id |
string |
信任委托id,长度为1到64个字符,只包含字母、数字和"-"的字符串。 |
|
agency_name |
string |
信任委托名称,长度为1到64个字符,只包含字母、数字、"_"、" "、"="、","、"."、"@"和"-"的字符串。 |
|
trust_domain_id |
string |
被委托方账号id,仅存在于委托中,不存在于信任委托中。 |
|
trust_domain_name |
string |
被委托方账号名,仅存在于委托中,不存在于信任委托中。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
string |
错误码。 |
|
error_msg |
string |
错误信息。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
string |
错误码。 |
|
error_msg |
string |
错误信息。 |
|
request_id |
string |
请求id。 |
|
encoded_authorization_message |
string |
加密后的认证失败信息,可以通过sts5解密接口进行解密。 |
状态码:409
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
string |
错误码。 |
|
error_msg |
string |
错误信息。 |
|
request_id |
string |
请求id。 |
请求示例
创建名为name的信任委托。
post https://{endpoint}/v5/agencies
{
"agency_name" : "name",
"path" : "",
"trust_policy" : "{\"version\":\"5.0\",\"statement\":[{\"action\":[\"sts:agencies:assume\",\"sts::tagsession\",\"sts::setsourceidentity\"],\"effect\":\"allow\",\"principal\":{\"iam\":[\"xxx\"]}}]}",
"max_session_duration" : 3600,
"description" : "description"
}
响应示例
状态码:201
请求成功。
{
"agency" : {
"urn" : "iam::accountid:agency:name",
"trust_policy" : "{\"version\":\"5.0\",\"statement\":[{\"action\":[\"sts:agencies:assume\",\"sts::tagsession\",\"sts::setsourceidentity\"],\"effect\":\"allow\",\"principal\":{\"iam\":[\"xxx\"]}}]}",
"created_at" : "2023-09-21t01:17:19.590z",
"description" : "description",
"max_session_duration" : 3600,
"path" : "",
"agency_id" : "string",
"agency_name" : "name",
"trust_domain_id" : null,
"trust_domain_name" : null
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
请求成功。 |
|
400 |
请求体异常。 |
|
403 |
没有操作权限。 |
|
409 |
请求冲突。 |
错误码
请参见错误码。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨