文档

ListOrganizationMembers - 查询企业成员信息列表

更新时间:

根据指定条件获取企业成员信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /organization/{organizationId}/members

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id

66c0c9fffeb86b450c199fcd
organizationMemberNamestring

企业成员名

名字1
providerstring

第三方系统(若是钉钉同步,则是 Dingtalk), 与 externUid 参数成对使用,只传其中一个,不生效。

Dingtalk
externUidstring

第三方系统的用户 id:若是钉钉同步,则是钉钉的员工 User ID;与 provider 参数成对使用,只传其中一个,不生效。

1236666
statestring

选项:正常(normal),已停用(blocked),已删除(deleted),只能指定一种;若不指定,默认返回正常(normal)状态的成员。

normal
nextTokenstring

分页中的起始序列,值为上一页请求返回的 nextToken 值。

""
maxResultslong

最大返回数量,0-50,默认值 20

20
joinTimeFromlong

加入云效企业时间,单位为毫秒时间戳

1631845101798
joinTimeTolong

加入云效企业时间,单位为毫秒时间戳

1631845101798
containsExternInfoboolean

返回信息中是否包含第三方信息,默认不包含。

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题

FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F
errorMessagestring

错误信息

error info
successboolean

true 接口调用成功,false 接口调用失败

true
errorCodestring

错误码

null
nextTokenstring

分页 Token

""
totalCountlong

总数

15
membersobject []

成员列表

accountIdstring

阿里云用户 UID

123456677888
birthdaylong

生日

1631845101798
deptListsarray

部门名称列表

string

部门名称

测试部门
emailstring

邮箱

123@mail.com
hiredDatelong

入职时间

1631845101798
identitiesobject

第三方信息

externUidstring

第三方系统的用户 Id

1236666
providerstring

第三方系统

Dingtalk
joinTimelong

加入云效企业时间

1631845101798
lastVisitTimelong

最近一次访问时间

1631845101798
mobilestring

手机号

1390000****
organizationMemberNamestring

企业成员名

名字1
organizationRoleNamestring

企业角色名字

管理员
organizationRoleIdstring

企业角色 Id

8fc0c9ff039711dd64acd000
statestring

用户状态(正常(normal),已停用(blocked),已删除(deleted))

normal
jobNumberstring

工号

373***

示例

正常返回示例

JSON格式

{
  "requestId": "FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F",
  "errorMessage": "error info",
  "success": true,
  "errorCode": "null",
  "nextToken": "\"\"",
  "totalCount": 15,
  "members": [
    {
      "accountId": "123456677888",
      "birthday": 1631845101798,
      "deptLists": [
        "测试部门"
      ],
      "email": "123@mail.com",
      "hiredDate": 1631845101798,
      "identities": {
        "externUid": "1236666",
        "provider": "Dingtalk"
      },
      "joinTime": 1631845101798,
      "lastVisitTime": 1631845101798,
      "mobile": "1390000****",
      "organizationMemberName": "名字1",
      "organizationRoleName": "管理员",
      "organizationRoleId": "8fc0c9ff039711dd64acd000",
      "state": "normal",
      "jobNumber": "373***"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidUser.UserNotInCurrentOrganizationThe user is not in the organization.当前用户不在该企业中
403InvalidParam.NoPermissionNo Permission.-
404InvalidOrganization.NotFoundThe organization is not found.企业不存在,请检查企业ID是否正确

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-04-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:containsExternInfo
2021-09-22新增 OpenAPI看变更集
  • 本页导读 (0)
文档反馈