GetMember - 查询成员信息

通过 OpenAPI 查询成员信息。

适用版本

企业专属版、企业标准版

说明

专属版“组织”对应标准版“企业”概念,本文在专属版中代表组织相关接口,在标准版中代表企业相关接口。

服务接入点与授权信息

请求语法

GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/members/{id}

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

组织 ID。

99d1****71d4

id

string

path

组织成员 ID。

3a41****3eca

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/platform/organizations/{organizationId}/members/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

-

object

deptIds

array[string]

所属组织部门列表。

[99d1****6124]

id

string

成员 ID。

99d1****6124

joined

string

加入时间,等于数据库的创建时间。

2023-08-31T03:59:16.201Z

name

string

成员名。

示例名

organizationId

string

组织 ID。

99d1****6124

roleIds

array[string]

角色信息。

[99d1****6124]

status

string

成员状态。

ENABLED

userId

string

用户 ID。

99d1****6124

visited

string

最后访问时间。

2023-08-31T03:59:16.201Z

返回示例

{
    "deptIds": [99d1****6124],
    "id": "99d1****6124",
    "joined": "2023-08-31T03:59:16.201Z",
    "name": "示例名",
    "organizationId": "99d1****6124",
    "roleIds": [99d1****6124],
    "status": "ENABLED",
    "userId": "99d1****6124",
    "visited": "2023-08-31T03:59:16.201Z"
}

错误码

访问错误码中心查看 API 相关错误码。