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