员工身份(EIAM)

获取用户社交账号列表

接口

# 权限

身份管理API是以应用维度授权的,在调用接口前需为不同的应用设置接口权限,详情请参考API权限

权限代码 描述
user_all 用户管理接口的读写权限
user_read 用户管理接口的读权限
all 全部接口读写权限
read 所有读接口的权限

# 请求说明

GET https://{your_domain}/api/v2/tenant/social?offset=0&limit=10&user_id=&idp_id=&type=

# 请求头

参数名 中文名称 必须 类型 描述
Authorization 授权 String 格式:Bearer {access_token}
Content-Type 内容类型 String 固定值:application/json; charset=utf-8

# 请求示例

# 请求参数

参数名 中文名称 必须 类型 描述
user_id 用户ID String 为空时查询所有用户
idp_id 认证源ID String 根据认证源ID查询
type 社交账号类型, String 根据社交类型查询。
weixin:微信
weibo:微博
qq:QQ
alipay:支付宝
douyin:抖音
apple:苹果
taobao:淘宝
dingding:钉钉
welink:WeLink
wechat_work:企业微信
feishu:飞书
yunjz:云之家
eteams:泛微Eteams
offset 分页页码 Int 从第0页开始, 默认为 0
limit 每页数量 Int 每页数量在10-100之间, 默认为 10

# 返回示例

正确示例:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "total": 1,
    "users": [
        {
        "user_id": "20230717135907546-17FF-D468F40C8",
        "social_channel_id": "wpk4vUEQAAQPvySm6u4zd1U3KnC6PA_Q/wok4vUEQAAIJS1-9FZnDSrqsQ-W6dYsA",
        "id": "20230217171147756-E6C5-50DB133AC",
        "idp_id": "20230728112541363-4C9F-3F073665D",
        "created_at": "2023-08-11 11:32:18.983",
        "type": "wechat_work",
        "social_uid": "wpk4vUEQAAQPvySm6u4zd1U3KnC6PA_Q/wok4vUEQAAIJS1-9FZnDSrqsQ-W6dYsA"
        }
    ]
}


错误示例:
HTTP/1.1 400 Bad Request
{
    "error_code": "OAP.PAGE.0003",
    "error_msg": "分页页码不符合校验规则"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# 返回参数

参数名 中文名称 类型 描述
total 总数 Int
users 用户社交信息集合 List
--id 社交绑定关系ID String 用于解绑用户社交账号接口参数
--user_id 用户ID String
--idp_id 组织ID String
--type 社交类型 String
--social_uid 社交唯一id String
--social_channel_id 同social_uid String 当社交类型是微信时,代表微信openId

# 错误码

状态码 错误码 错误信息 处理措施
400 OAP.PAGE.0001 分页参数错误 请检查入参分页参数是否填写正确
Page parameter error
400 OAP.PAGE.0003 分页页码不符合校验规则 请检查入参分页页码是否正确
The pagination page number does not meet the verification rules
400 OAP.PAGE.0004 每页数量不符合校验规则 请检查入参每页数量是否正确
The number of pages does not meet the verification rules