认证接口

爱搭贝
更新于2025-03-03

搭贝认证用户信息

场景

用户服务可通过本接口

接口地址

/oauth2/users/user_info

请求方式

GET

请求参数

参数名类型必填说明
client_idstring客户端身份标识,由搭贝提供
client_secretstring客户端密钥,由搭贝提供
grant_typestring固定值 authorization_code
codestringoauth的code,根据code获取token

响应参数

参数名类型说明
idstring用户id
departmentIdstring主部门
departmentIdsarray->string兼职部门
namestring用户姓名
usernamestring用户姓名
phonestring手机号,注意:只有用户配置此值有效,主要用于私有化部署

样例:

{
  "errcode": 0,
  "errmsg": "success",
  "data": {
    "departmentId": "3f9366618cb843c287b3290ec3b8e2a1",
    "departmentIds": [
      "3f9366618cb843c287b3290ec3b8e2a1"
    ],
    "id": "46e9258b7205453697e381c9b4b5477c",
    "phone": "18912341234",
    "username": "user001",
    "name": "李易峰"
  },
  "success": true
}

自有认证中心接口

此模式下,以用户自有认证中心为主,搭贝提供接口以实现sso对接。 注意:使用此模式,phone和username必有值

获取搭贝authority_code

场景

三方自有认证中心通过本接口向搭贝发起请求获取搭贝为某个用户分配的授权code,获取该code后可以带着code redirect至搭贝原页面,搭贝前后端将根据本code自动实现认证,也可以通过该code通过服务端获取用户信息

接口地址

/oauth2/authority_code

请求方式

GET

请求参数

参数名类型必填说明
client_idstring客户端身份标识,由搭贝提供
client_secretstring客户端密钥,由搭贝提供
usernamestring选择性必填与phone二选一,优先本选项
phonestring选择性必填与username二选一,优先按username获取

响应参数

参数名类型说明
codestring授权code,此code与搭贝oauth2 code完全相同,可以:
1.在浏览器跳转至搭贝应用的url拼接code=$authority_code以实现页前端用户免登录。
2.服务端可以根据本code获取搭贝的用户信息以实现自定义业务扩展

样例:

{
  "errcode": 0,
  "errmsg": "success",
  "data": {
    "code":"cc58f62261ed4a5099bcea41d6fdcbaa"
  },
  "success": true
}