使用者管理 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的用戶對象

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

請求

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