用户生命周期管理
接口调用说明
此页面上的所有端点都以BaseUrl为首拼接，您的baseUrl如下所示：
https://${yourXAuthDomain}
SSWS Token：
请求以下的API需要包含api_token, 通过管理员登录XAuth的控制台，【API】-【Token】-【创建token】来创建调用管理API的Token
锁定用户
PUT ${baseUrl}/api/v1/account/user/:userId/lifecycle/lock
锁定用户
请求示例
curl -X 'PUT' \
'https://${yourXAuthDomain}/api/v1/account/user/:userId/lifecycle/lock' \
-H 'accept: application/json' \
-H 'Authorization: SSWS ${api_token}'\
-d 'userId:string'
| 参数 | 描述 | 是否必填 | 类型 |
|---|---|---|---|
| userId | 用户ID，该属性唯一 ，从用户详情url最后一个路径获得 | 是 | String |
响应示例
null
解锁用户
PUT ${baseUrl}/api/v1/account/user//:userId/lifecycle/unlock
解锁用户
请求示例
curl -X 'PUT' \
'https://${yourXAuthDomain}/api/v1/account/user/:userId/lifecycle/unlock' \
-H 'accept: application/json' \
-H 'Authorization: SSWS ${api_token}'\
-d 'userId:string'
| 参数 | 描述 | 是否必填 | 类型 |
|---|---|---|---|
| userId | 用户ID，该属性唯一 ，从用户详情url最后一个路径获得 | 是 | String |
响应示例
null
停用用户
PUT ${baseUrl}/api/v1/account/user/:userId/lifecycle/deactivate
用户停用后，无法登录系统。
请求示例
curl -X 'PUT' \
'https://${yourXAuthDomain}/api/v1/account/user/:userId/lifecycle/deactivate' \
-H 'accept: application/json' \
-H 'Authorization: SSWS ${api_token}' \
-d 'userId:string'
| 参数 | 描述 | 是否必填 | 类型 |
|---|---|---|---|
| userId | 用户ID，该属性唯一 ，从用户详情url最后一个路径获得 | 是 | String |
响应示例
null
启用用户
PUT ${baseUrl}/api/v1/account/user/:userId/lifecycle/activate
启用用户
请求示例
curl -X 'PUT' \
'https://${yourXAuthDomain}/api/v1/account/user/:userId/lifecycle/activate' \
-H 'accept: application/json' \
-H 'Authorization: SSWS ${api_token}'\
-d 'userId:string'
| 参数 | 描述 | 是否必填 | 类型 |
|---|---|---|---|
| userId | 用户ID，该属性唯一 ，从用户详情url最后一个路径获得 | 是 | String |
响应示例
null
暂停用户
PUT ${baseUrl}/api/v1/account/user/:userId/lifecycle/suspend
暂停用户
请求示例
curl -X 'PUT' \
'https://${yourXAuthDomain}/api/v1/account/user/:userId/lifecycle/suspend' \
-H 'accept: application/json' \
-H 'Authorization: SSWS ${api_token}'\
-d 'userId:string'
| 参数 | 描述 | 是否必填 | 类型 |
|---|---|---|---|
| userId | 用户ID，该属性唯一 ，从用户详情url最后一个路径获得 | 是 | String |
响应示例
null
删除用户
PUT ${baseUrl}/api/v1/account/user/:userId/lifecycle/remove
删除用户
请求示例
curl -X 'PUT' \
'https://${yourXAuthDomain}/api/v1/account/user/:userId/lifecycle/remove' \
-H 'accept: application/json' \
-H 'Authorization: SSWS ${api_token}'\
-d 'userId:string'
| 参数 | 描述 | 是否必填 | 类型 |
|---|---|---|---|
| userId | 用户ID，该属性唯一 ，从用户详情url最后一个路径获得 | 是 | String |
响应示例
null
