批量获取帐号登录的authKey

批量获取帐号登录的authKey

1. 接口描述

接口名称:

/confopenapi/account/authkey/get

发送方式:

POST

参数格式:

accept: application/json;content-type: application/json

2. 输入参数

Http Header

参数名 必选 类型 说明
token 接口调用鉴权参数 也可以放在http body中

Http Body

参数名 必选 类型 说明
loginnames []string 用户登录名数组; 最大成员 50 个;选填 (万科这里默认传参是域账号)
extLogins []object ad 域用户登录名数组; 最大成员 50 个;选填
create bool 是否生成新的 authKey, 选填, 默认:false。true代表新建,false会按照传递的expireTime的值更新authkey的有效期
expireTime int64 过期时间, Unix 时间戳(精确到毫秒). -1, 永久不过期; 必填。

extLogins数组中object的参数:

参数名 必选 类型 说明
extloginname string 用户 ldap 登陆的 name
siteid string 站点 ID

请求示例

请求示例

{
    "loginnames": ["20190918test5@quanshitest.com", "wu_923_b_055@qs.com"],
    "extLogins": [{
        "extloginname": "ad_wy03",
        "siteid": "76473"
    }],
    "create": true,
    "expireTime": 1619861074000
}

3. 返回参数

参数名 类型 说明
status int 0:成功,非0失败
result json数组 返回值
request_id string 请求唯一标识
timestamp int64 服务器时间戳

返回result数组内object参数说明

参数名 类型 说明
userId uint64 账号对应的ums userId
loginname string 账号的登录名
authKey string 用户 authKey, 如果用户 authKey 不存在, 此字段 为空
expireTime int64 用户 authKey 过期时间,Unix 时间戳(毫秒); -1 表示永不 过期。如果用户 authKey 不存在, 此字段为空

错误码

返回值 说明
51210 从UMS批量获取authkey失败

返回示例

{
    "status": 0,
    "result": [
        {
            "userId": 64050819,
            "loginname": "ad_wy03@haier.com",
            "authKey": "f4265c94-accf-4892-9a61-52ac19418916",
            "expireTime": 1619861074000
        },
        {
            "userId": 81586150,
            "loginname": "20190918test5@quanshitest.com",
            "authKey": "3f9458ba-0b1c-4094-9fc1-e81bffd774ee",
            "expireTime": 1619861074000
        },
        {
            "userId": 63675723,
            "loginname": "wu_923_b_055@qs.com",
            "authKey": "9f117860-f027-454f-baa3-14b5f81be113",
            "expireTime": 1619861074000
        }
    ],
    "request_id": "confopenapiserver-192.168.0.183-1619592136.557235000.81",
    "timestamp": 1619592136557,
    "content_type": "application/json",
    "request_duration": "200.956369ms"
}

备注

  • 更多返回错误代码请看首页的错误代码描述