用户管理 API 方法

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

创建用户

用于创建新用户的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的用户对象

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

请求

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方法。

请求

DELETE /api/v1/users/<user_id>

如果成功,则返回204 No Content。 如果发生冲突,则返回409 Conflict

批量删除用户

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

请求

POST /api/v1/users/bulk-delete

示例请求正文

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

在此页面上