Join Users¶
Assign users to an organization without logging in to Application Portal.
Operation Permissions¶
In Application Portal, the application must be granted the “Create or delete user accounts in the OU” permission.
Request Format¶
POST https://{apigw-address}/app-portal-service/v2.2/user/users/join
Request Parameters (Body)¶
Name |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|
organizationId |
Mandatory |
String |
The organization ID. How to get organizationId>> |
userIds |
Mandatory |
List |
The user ID to be assigned to the organization |
Response Parameters¶
Name |
Data Type |
Description |
---|---|---|
data |
Boolean |
|
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 |
Organization not found |
31408 |
This user already existed in this organization |
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
}