使用者管理 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>, ...]}

本頁內容