用户管理 API 方法

保留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>, ...]}

在此页面上

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now