Join Users¶

Assign users to an organization in batch. You can assign up to 1000 users at a time.

Prerequisites¶

The application has been granted the “Create or delete user accounts in the OU” permission. Contact the OU administrator to get the permission if necessary.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.2/user/users/join

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
organizationId	Required	String	The OU ID to be assigned to. How to get organizationId >>
userIds	Required	List	The user IDs to be assigned to the OU, supporting up to 1000 IDs. How to get userId >>

Response Parameters¶

Name	Data Type	Description
data	Boolean	Whether the users are added successfully. `true` means the users are added successfully, `false` means the adding fails.

Error Codes¶

Code	Description
31400	Errors such as incorrect parameters, empty parameters, character limits exceeded, and so on
31403	The application has not been granted the “Create or delete user accounts in the OU” permission
31404	OU not found
31408	This user already existed in this OU

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/user/users/join

method: POST

requestBody:
{"organizationId":"yourOrgId","userIds": ["user1","user2","user3"]}

Return Sample¶

{
  "code": 0,
  "message": "OK",
  "data": true
}