管理接口_应用身份服务 (IDaaS)(IDaaS)-阿里云帮助中心

管理侧接口一般为业务系统的用户管理系统调用，管理侧接口主要负责账号信息的维护以及生命周期的管理,都受到管理应用 accessToken 的保护。

1. 令牌有效性检验

应用服务端可通过此接口验证服务端token的有效性。

接口地址：

Request URI: GET /api/bff/v1.2/developer/ciam/management/token/check

返回参数

token有效返回参数

参数名	类型	示例
success	boolean	true
code	int	Operation.Success
message	string	null
requestId	string	8D5CDDCF-C77A-4A0A-A8A6-16314E57847F
data	json	null

token失效返回参数：

参数名	类型	示例	内容说明
error	string	invalid_token	无效
error_description	int	Invalid access token: eyJhbGciOiJIU ... ... WJferRYl0	token无效

2. 获取用户信息

查看指定用户的基本信息。

接口地址

Request URI: GET /api/bff/v1.2/developer/ciam/management/user

请求参数

参数名	类型	必须	内容说明
userUuid	string	是	用户唯一标识
userType	string	否	自定义用户类型，默认为普通用户

返回参数

参数名	类型	描述
userId	String	用户唯一标识
displayName	String	显示名称
username	String	用户名
phoneNumber	String	手机号
phoneRegion	String	手机区号
email	String	邮箱地址
dataDictionaries	Array	数据字典是 IDaaS 中实现账户扩展属性的机制。管理员在数据字典中定义好账户可存储的自定义属性后，就可以存储自定义用户数据，可以在这里获取查看。
remark	String	用户来源
uamParams	Map
locked	boolean	用户是否锁定
enabled	boolean	用户是否禁用
createTime	Date	用户注册时间
sourceApplicationUuid	String	注册来源应用ID

3. 通过社交账号ID获取用户信息

通过用户在社交媒体上的唯一标识来查询对应的用户信息。

接口地址

Request URI: GET /api/bff/v1.2/developer/ciam/management/social/userinfo

请求参数

参数名	类型	必须	内容说明
socialUserId	string	是	社交媒体上用户的唯一标识
socialId	string	是	社交媒体类型，为IDaaS侧定义

返回参数

参数名	类型	描述
userUuid	String	用户唯一标识
displayName	String	显示名称
username	String	用户名
phoneNumber	String	手机号
phoneRegion	String	手机区号
email	String	邮箱地址
dataDictionaries	Array	数据字典是 IDaaS 中实现账户扩展属性的机制。管理员在数据字典中定义好账户可存储的自定义属性后，就可以存储自定义用户数据，可以在这里获取查看。
remark	String	用户来源
uamParams	Map
locked	boolean	用户是否锁定
enabled	boolean	用户是否禁用
createTime	Date	用户注册时间
sourceApplicationUuid	String	注册来源应用ID

4. 添加用户

查看指定用户的基本信息。

接口地址

Request URI: POST /api/bff/v1.2/developer/ciam/management/user

请求参数

参数名	类型	必须	描述
username	String	是	用户名
password	String	是	密码
phoneNumber	String	是	手机号
phoneRegion	String	否	手机区号
email	String	否	邮箱地址
userType	String	否	用户类型
externalId	String	否	外部Id
dataDictionaries	Array	否	数据字典是 IDaaS 中实现账户扩展属性的机制。管理员在数据字典中定义好账户可存储的自定义属性后，就可以存储自定义用户数据。

请求示例

{
  "username": "pftest125",
  "password": "Test123456",
  "phoneNumber": "178****1215",
  "email": "855**@qq.com",
  "externalId": "125",
  "dataDictionaries": [
    {
      "dictionaryCode": "languages",
      "value": "en"
    },
    {
      "dictionaryCode": "sex",
      "value": "男"
    }
  ]
}

返回参数

参数名	类型	示例	描述
userUuid	String	65********93926885	用户在IDaaS唯一标识

返回示例

{
    "success": true,
    "code": "Operation.Success",
    "message": "Operation.Success",
    "requestId": "1668062119444$c91e1df2-2450-c0ab-876c-dce7356fbc43",
    "data": {
        "userUuid": "65********93926885"
    }
}

5. 启用用户

启用用户后，用户即可以正常使用。

接口地址

Request URI: POST /api/bff/v1.2/developer/ciam/management/user/enable

Content-Type: application/json

请求参数

参数名	类型	必须	描述
userUuid	string	是	用户唯一标识
userType	userType	否	userType

返回参数

参数名	类型	示例	内容说明
success	boolean	true	启动成功
code	int	Operation.Success	事件结果代码
message	string	null	补充信息
requestId	string	8D5CDDCF-C77A-4A0A-A8A6-16314E57847F	唯一标识符
data	json	null	日志

code错误码

序号	错误码	描述
1	Operation.Success	请求完成
2	Operation.Failure.User.Enabled	操作失败，用户已启用

6. 禁用用户

禁用指定账户。账户禁用后，将不能进行任何操作，无法登录。

接口地址

Request URI: POST /api/bff/v1.2/developer/ciam/management/user/disable

Content-Type: application/json

请求参数

参数名	类型	必须	描述
userUuid	String	是	用户唯一标识
userType	userType	否	userType

返回参数

参数名	类型	示例	内容说明
success	boolean	true	请求成功
code	int	Operation.Success	禁用成功
message	string	null	请求信息
requestId	string	8D5CDDCF-C77A-4A0A-A8A6-16314E57847F	请求唯一标识
data	json	null	日志

code错误码

序号	错误码	描述
1	Operation.Success	禁用成功
2	Operation.Failure.User.Enabled	禁用失败

7. 解锁用户

当用户在端上登录超过风险控制设置的次数后会自动锁定一段时间，管理侧可以使用本接口来主动为用户解锁。

接口地址

Request URI: POST /api/bff/v1.2/developer/ciam/management/user/unlock

Content-Type: application/json

请求参数

参数	类型	必须	描述
userUuid	String	是	用户唯一标识
userType	string	否	自定义用户类型，默认为普通用户

返回参数

参数名	类型	示例	内容说明
success	boolean	true	操作成功
code	int	Operation.Success	解禁成功
message	string	null	请求信息
requestId	string	8D5CDDCF-C77A-4A0A-A8A6-16314E57847F	请求ID
data	json	null	日志

code错误码

序号	错误码	描述
1	Operation.Success	解禁成功
2	Operation.Failure.User.Enabled	解禁失败

8. 获取微信小程序Token

IDaaS服务端维护小程序应用的accessToken，小程序应用服务端token会相互之间有影响，比如新的token产生会使老的token失效。

IDaaS侧当使用微信小程序授权登录，则服务端必须使用小程序的accessToken，会使之前其他应用侧的accessToken失效，固IDaaS对外提供获取小程序accessToken接口。

IDaaS侧会对小程序token缓存，当缓存过期时，系统会自动向微信端重新请求access_token。

接口地址

Request URI: GET /api/bff/v1.2/developer/ciam/management/token/wechat_micro_program

请求参数

参数名	类型	必须	内容说明
enterpriseAuthId	string	是	对应微信小程序认证源的UUID

返回参数

参数名	类型	示例	内容说明
access_token	string	C77A-4A0A-A8A6-16314E57847F	获取到的凭证
expires_in	number	3600	凭证有效时间，单位：秒。目前是7200秒之内的值。
errcode	number	1	错误码
errmsg	string	null	错误信息