更新时间:2026-01-08 GMT+08:00
分享

获取用户信息 - ShowUserInfo

功能介绍

根据用户ID获取指定用户信息。

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsgovernance::getBinaryUser

Read

-

-

-

-

URI

GET /v1/{project_id}/sbc/user/info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

用户项目ID,获取方式请参见获取项目ID

约束限制:

不涉及。

取值范围:

32位项目ID。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

user_id

String

参数解释:

用户ID,值来源于IAM的用户ID。

约束限制:

不涉及。

取值范围:

字符串长度不小于0,不大于256。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

Content-Type

String

参数解释:

编码格式。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

application/json:传任何值,接口返回值均为json格式。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

data object

参数解释:

响应内容。

取值范围:

不涉及。

表5 data

参数

参数类型

描述

user_id

String

参数解释:

用户ID。

取值范围:

字符串长度不小于0,不大于256。

white_list

Boolean

参数解释:

是否为白名单用户。

取值范围:

  • true:是白名单用户。

  • false:不是白名单用户。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及。

状态码:429

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及。

请求示例

获取指定用户信息。

GET https://{endpoint}/v1/{project_id}/sbc/user/info?user_id={user_id}

响应示例

状态码:200

Request succeeded!

{
  "data" : {
    "white_list" : false,
    "user_id" : "12345678"
  }
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

429

Too Many Requests

错误码

请参见错误码

相关文档