查看授权列表
功能介绍
查看授权列表接口用于查看授权信息。该接口适用于以下场景:当用户需要了解当前的授权情况、审核权限分配或管理权限时,可通过此接口查看授权列表。使用该接口的前提条件是用户具备查看授权的权限。查看操作完成后,将返回授权列表,包括被授权的资源、授权类型以及授权内容等信息。若用户无权限查看或授权列表不存在,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/authorizations
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:用户项目ID,获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
sort_by |
否 |
String |
参数解释:指定排序字段。 约束限制:不涉及。 取值范围:枚举类型,取值如下:
默认取值:user_name。 |
order |
否 |
String |
参数解释:排序方式。 约束限制:不涉及。 取值范围:枚举类型,取值如下:
默认取值:ASC。 |
limit |
否 |
Integer |
参数解释:指定每一页返回的最大条目数。 约束限制:不涉及。 取值范围:[1,1000]。 默认取值:1000。 |
offset |
否 |
Integer |
参数解释:分页列表的起始页。 约束限制:不涉及。 取值范围:非负整数。 默认取值:0。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total_count |
Number |
参数解释:授权信息总数。 取值范围:不涉及。 |
auth |
Array of AuthorizationResponse objects |
参数解释:授权信息列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
参数解释:用户ID,获取方法请参见获取用户ID和名称。当user_id为all时,表示对所有IAM子用户进行授权,如果已有部分用户已授权,则更新授权。仅当授权类型为委托时,需要该字段。 约束限制:不涉及。 取值范围:字符串长度在3到32个字符之间,支持大小写字母、数字、中划线。 默认取值:不涉及。 |
type |
String |
参数解释:授权类型。推荐使用委托方式。 约束限制:不涉及。 取值范围:枚举类型,取值如下:
默认取值:不涉及。 |
content |
String |
参数解释:授权内容。 约束限制:
取值范围:长度限制64个字符。 默认取值:不涉及。 |
secret_key |
String |
参数解释:秘密访问密钥(SK)。 约束限制:仅当授权类型为访问密钥时,需要该字段。 取值范围:字符串长度为40,支持大小写字母、数字。 默认取值:不涉及。 |
user_name |
String |
参数解释:用户名。 约束限制:当user_id为all-users时,显示为所有用户。 取值范围:不涉及。 默认取值:不涉及。 |
user_type |
String |
参数解释:用户类型。 约束限制:不涉及。 取值范围:枚举类型,取值如下:
默认取值:IAM。 |
create_time |
Long |
参数解释:创建时间戳。 取值范围:不涉及。 |
请求示例
查看授权列表
GET https://{endpoint}/v2/{project_id}/authorizations
响应示例
状态码:200
OK。
{ "total_count" : 1, "auth" : [ { "user_id" : "****d80fb058844ae8b82aa66d9fe****", "user_name" : "iam-user01", "type" : "agency", "content" : "modelarts_agency", "create_time" : 15657747821288 } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK。 |
400 |
Bad Request。 |
401 |
Unauthorized。 |
403 |
Forbidden。 |
404 |
Not Found。 |
错误码
请参见错误码。