Show Menu
主题×

用户管理 API 方法

其余 API 管理用户的方法,包括创建、更新、列出、删除和返回用户对象。

Create a User

POST 于创建新用户的方法。

请求

POST /api/v1/users/

示例请求主体

{ 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...], 
  "isAdmin" : true | false 
}

响应

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...], 
  "isAdmin" : <"true"|"false"> 
 
}

isAdmin 果设置为true,则创建用户为合作伙伴管理员。 此属性还让您了解用户是否为合作伙伴管理员。
409 Conflict 回用户名(如果已使用)。

更新用户

一种 PUT 用户更新的方法。

请求

PUT /api/v1/users/ <userId>

示例请求主体

{ 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...] 
}

响应

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "groups" : [<group_1_id>, ...] 
 
}

409 Conflict 回用户名(如果已使用)。

更新登录用户

PUT 于更新当前登录用户的方法。
大多数 API 方法只能由合作伙伴管理员调用,而此方法可由非管理员用户调用。

请求

PUT /self/update

示例请求主体

{  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null> 
}

响应

{ 
  "userId": <integer>,,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string> 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null> 
}

409 Conflict 回用户名(如果已使用)。

更新登录用户密码

PUT 于更新当前登录用户的方法。
大多数 API 方法只能由合作伙伴管理员调用,而此方法可由非管理员用户调用。

请求

POST /users/self/update-password

示例请求主体

{ "oldPassword" : "old password", "newPassword" : "new password" }

成功 200 OK 时返回。 如果 400 Bad Request 任何一个密码出错,则返回。

重置登录用户密码

PUT 于重置当前登录用户的方法。 Audience Management 向用户发送系统生成的口令。
大多数 API 方法只能由合作伙伴管理员调用,而此方法可由非管理员用户调用。

请求

POST /self/reset-password
成功 200 OK 时返回。

返回用户ID的用户对象

Get 种为用户ID返回用户对象的方法。

请求

GET /api/v1/users/ <userId>

响应

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<groupd_id_1>, ...] 
 
}

返回登录用户的用户对象

Get 于返回当前登录用户的用户对象的方法。
大多数 API 方法只能由合作伙伴管理员调用,而此方法可由非管理员用户调用。

请求

GET /api/v1/users/self

响应

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<groupd_id_1>, ...] 
 
}

列表用户

一种 GET 列表用户的方法。

请求

GET /api/v1/users/
您可以在查询参数中指定多个组ID:
GET /api/v1/users/?groupId=343&groupdId=12
此查询返回指定组中所有用户的列表。

响应

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...] 
 
}

Delete a User

一种 DELETE 删除用户的方法。

请求

DELETE /api/v1/users/ <user_id>
成功 204 No Content 时返回。 如果冲突再次发生 409 Conflict

批量删除用户

一种 POST 批量删除多个用户的方法。

请求

POST /api/v1/users/bulk-delete

示例请求主体

{[<user_id_1>, <user_id_2>, ...]}