Employee Identity (EIAM)
Get User Social Account List
API
# Permissions
The Identity Management API is authorized at the application level. Before calling the interface, you need to set interface permissions for different applications. For details, please refer to API Permissions.
| Permission Code | Description |
|---|---|
| user_all | Read and write permissions for user management interfaces |
| user_read | Read permissions for user management interfaces |
| all | Read and write permissions for all interfaces |
| read | Permissions for all read interfaces |
# Request Description
GET https://{your_domain}/api/v2/tenant/social?offset=0&limit=10&user_id=&idp_id=&type=
# Request Headers
| Parameter Name | Chinese Name | Required | Type | Description |
|---|---|---|---|---|
| Authorization | Authorization | Yes | String | Format: Bearer {access_token} |
| Content-Type | Content Type | Yes | String | Fixed value: application/json; charset=utf-8 |
# Request Example
None
# Request Parameters
| Parameter Name | Chinese Name | Required | Type | Description |
|---|---|---|---|---|
| user_id | User ID | No | String | When empty, queries all users |
| idp_id | Identity Provider ID | No | String | Query by Identity Provider ID |
| type | Social Account Type | No | String | Query by social type. weixin: WeChat weibo: Weibo qq: QQ alipay: Alipay douyin: Douyin apple: Apple taobao: Taobao dingding: DingTalk welink: WeLink wechat_work: WeChat Work feishu: Feishu yunjz: Yunjia eteams: Fanwei Eteams |
| offset | Page Number | No | Int | Starts from page 0, default is 0 |
| limit | Items Per Page | No | Int | Items per page between 10-100, default is 10 |
# Response Example
Correct Example:
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"
}
]
}
Error Example:
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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Response Parameters
| Parameter Name | Chinese Name | Type | Description |
|---|---|---|---|
| total | Total Count | Int | |
| users | User Social Information Collection | List | |
| --id | Social Binding Relationship ID | String | Used as a parameter for the unbind user social account interface |
| --user_id | User ID | String | |
| --idp_id | Organization ID | String | |
| --type | Social Type | String | |
| --social_uid | Social Unique ID | String | |
| --social_channel_id | Same as social_uid | String | When the social type is WeChat, it represents the WeChat openId |
# Error Codes
| Status Code | Error Code | Error Message | Action |
|---|---|---|---|
| 400 | OAP.PAGE.0001 | Pagination parameter error | Please check if the input pagination parameters are correct |
| Page parameter error | |||
| 400 | OAP.PAGE.0003 | The pagination page number does not meet the validation rules | Please check if the input page number is correct |
| The pagination page number does not meet the verification rules | |||
| 400 | OAP.PAGE.0004 | The number of items per page does not meet the validation rules | Please check if the input number of items per page is correct |
| The number of pages does not meet the verification rules |