...
| Service | API | Method | Data Model | Workflow |
|---|
| urac | /admin/users/uninvite | PUT | Users | |
Description
For each user you sent the following happens:
- check if user is there and is already invited to the tenant
- if yes remove the tenant from allowedTenants and push user to succeeded array response
- if not push user to failed array response with reason "Model error: User: user [" + user(id, email, username) + "] was not uninvited."
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|
UsersObject| Array | includes user object, groups array, and pin object |
|
|
| Name | Source | Mandatory | Type | Special Format | Description |
|---|
| user | Body | YES | Object | Includes one of id, username, or email | User Object |
| One of the following should exist under the user object: | Name | Mandatory | Type | Special Format | Description |
|---|
| id | YES | String | N/A | User ID | | username | YES | String | N/A | Username | | email | YES | String | N/A | User Email |
|
|
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
| Code Block |
|---|
| language | js |
|---|
| title | Valid Response Sample |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
result: true,
data: {
succeeded: [ { id: '5da721b6c257840b3fe44377' } ],
failed: 1 []
}
} |
Invalid Response
| Code Block |
|---|
| language | js |
|---|
| title | Error Response Sample |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
} |
Response validation
| Name | Mandatory | Type | Special Format | Description |
|---|
| succeeded | YES | Array | Array of Objects | Succeeded response information |
| One of the following should exist under the succeeded object: | Name | Mandatory | Type | Special Format | Description |
|---|
| id | YES | String | N/A | User ID | | username | YES | String | N/A | Username | | email | YES | String | N/A | User Email |
|
| failed | YES | String | N/A | Failed response information |
|
| Name | Mandatory | Type | Special Format | Description |
|---|
| reason | YES | String | N/A | Failing reason |
|
Response schema
Follow this link to check out the response JSON response JSON Schema
SOAJS Error Codes
| |
|---|
| 400 | Business logic required data are missing |
| 530 | Users array is required |
| 602 | Model error: + %model_error% |