明道云开放平台

正在加载页面

鉴权方式

AppKey + Sign 是应用密钥鉴权，由管理员创建，用于以应用管理员身份访问应用数据。

版本

请求地址

GET

Header 参数

名称	类型	必填	描述
`HAP-Appkey`	`string`	是	HAP应用密钥
`HAP-Sign`	`string`	是	HAP签名

Query 参数

名称	类型	必填	描述
`name`	`string`	否	人员名称（精准匹配）
`orgId`	`string`	否

响应参数

200成功查找成员

名称	类型	描述
`success`	`boolean`	是否调用成功
`error_code`	`integer`	错误代码
`error_msg`	`string`	错误消息
`data`	`object`	成员查找结果
`data.users`	`object[]`	用户列表
`data.users.accountId`	`string`	用户ID
`data.users.name`	`string`	姓名
`data.users.mobile`	`string`	带掩码的手机号
`data.users.email`	`string`	邮箱，脱敏规则：前缀长度 > 4：去掉前缀最后 4 位，余下部分 + ** + @域名。例：abcdefg@example.com → abc@example.com 前缀长度 2～4：保留首字母 + * + @域名。例：ab@example.com → a***@example.com
`data.users.departments`	`object[]`	部门信息
`data.users.departments.id`	`string`	部门id
`data.users.departments.name`	`string`	部门名称
`data.users.departments.path`	`string`	部门路径 "最高级部门名称/.../父部门名称"
`data.users.departments.pathNodes`	`object[]`	部门路径列表
`data.users.departments.pathNodes.id`	`string`	部门id
`data.users.departments.pathNodes.name`	`string`	部门名称
`data.users.job`	`string`	用户在当前组织内担任的职位名称

curl -X GET "https://example.com/v3/users/lookup?orgId=%E7%BB%84%E7%BB%87+id%0A%E5%BD%93%E4%BD%BF%E7%94%A8+AppKey%2BSign+%E9%89%B4%E6%9D%83%E6%97%B6%EF%BC%8C%E4%B8%8D%E9%9C%80%E8%A6%81%E4%BC%A0%EF%BC%8C%E8%BF%94%E5%9B%9E%E5%BA%94%E7%94%A8%E5%BD%92%E5%B1%9E%E7%BB%84%E7%BB%87%E7%9A%84%E9%83%A8%E9%97%A8%E4%BF%A1%E6%81%AF%E5%BD%93%E4%BD%BF%E7%94%A8+%E4%B8%AA%E4%BA%BA%E8%AE%BF%E9%97%AE%E4%BB%A4%E7%89%8C%EF%BC%88PAT%EF%BC%89%2Foauth+%E9%89%B4%E6%9D%83%E6%97%B6%EF%BC%8C%E5%BF%85%E5%A1%AB%EF%BC%8C%E9%9C%80%E4%BC%A0%E5%85%A5%E6%9F%A5%E8%AF%A2%E7%BB%84%E7%BB%87+id%2C%E8%BF%94%E5%9B%9E%E5%AF%B9%E5%BA%94%E7%BB%84%E7%BB%87%E7%9A%84%E9%83%A8%E9%97%A8%E4%BF%A1%E6%81%AF" \  -H "HAP-Appkey: {{HAP-Appkey}}" \  -H "HAP-Sign: {{HAP-Sign}}"

{  "data": {    "users": [      {        "accountId": "user_001",        "mobile": "138****5678",        "email": "ali****@mail.com",        "departments": [          {            "id": "dep_001",            "name": "部门A",            "path": "公司/部门A",            "pathNodes": [              {                "id": "dep_000",                "name": "公司"              },              {                "id": "dep_001",                "name": "部门A"              }            ]          }        ],        "name": "Alice",        "job": "string"      }    ]  },  "success": true}

名称

类型

必填

描述

HAP-Appkey

string

是

HAP应用密钥

HAP-Sign

string

是

HAP签名

名称

类型

必填

描述

name

string

否

人员名称（精准匹配）

orgId

string

否

名称

类型

描述

success

boolean

是否调用成功

error_code

integer

错误代码

error_msg

string

错误消息

data

object

成员查找结果

data.users

object[]

用户列表

data.users.accountId

string

用户ID

data.users.name

string

姓名

data.users.mobile

string

带掩码的手机号

data.users.email

string

邮箱，脱敏规则：
前缀长度 > 4：去掉前缀最后 4 位，余下部分 + **** + @域名。例：abcdefg@example.com → abc****@example.com
前缀长度 2～4：保留首字母 + *** + @域名。例：ab@example.com → a***@example.com

data.users.departments

object[]

部门信息

data.users.departments.id

string

部门id

data.users.departments.name

string

部门名称

data.users.departments.path

string

部门路径
"最高级部门名称/.../父部门名称"

data.users.departments.pathNodes

object[]

部门路径列表

data.users.departments.pathNodes.id

string

部门id

data.users.departments.pathNodes.name

string

部门名称

data.users.job

string

用户在当前组织内担任的职位名称

curl -X GET "https://example.com/v3/users/lookup?orgId=%E7%BB%84%E7%BB%87+id%0A%E5%BD%93%E4%BD%BF%E7%94%A8+AppKey%2BSign+%E9%89%B4%E6%9D%83%E6%97%B6%EF%BC%8C%E4%B8%8D%E9%9C%80%E8%A6%81%E4%BC%A0%EF%BC%8C%E8%BF%94%E5%9B%9E%E5%BA%94%E7%94%A8%E5%BD%92%E5%B1%9E%E7%BB%84%E7%BB%87%E7%9A%84%E9%83%A8%E9%97%A8%E4%BF%A1%E6%81%AF%E5%BD%93%E4%BD%BF%E7%94%A8+%E4%B8%AA%E4%BA%BA%E8%AE%BF%E9%97%AE%E4%BB%A4%E7%89%8C%EF%BC%88PAT%EF%BC%89%2Foauth+%E9%89%B4%E6%9D%83%E6%97%B6%EF%BC%8C%E5%BF%85%E5%A1%AB%EF%BC%8C%E9%9C%80%E4%BC%A0%E5%85%A5%E6%9F%A5%E8%AF%A2%E7%BB%84%E7%BB%87+id%2C%E8%BF%94%E5%9B%9E%E5%AF%B9%E5%BA%94%E7%BB%84%E7%BB%87%E7%9A%84%E9%83%A8%E9%97%A8%E4%BF%A1%E6%81%AF" \ -H "HAP-Appkey: {{HAP-Appkey}}" \ -H "HAP-Sign: {{HAP-Sign}}"

{ "data": { "users": [ { "accountId": "user_001", "mobile": "138****5678", "email": "ali****@mail.com", "departments": [ { "id": "dep_001", "name": "部门A", "path": "公司/部门A", "pathNodes": [ { "id": "dep_000", "name": "公司" }, { "id": "dep_001", "name": "部门A" } ] } ], "name": "Alice", "job": "string" } ] }, "success": true}