General Information
| Service | API | Method |
|---|---|---|
| urac | /admin/inviteUser | Post |
Data Model: Users
Workflow:
Input
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description | |
|---|---|---|---|---|---|---|
| username | Query | NO | String | N/A | the user username (either username or email should be provided) | |
| Query | NO | String | N/A | the user email (either username or email should be provided) | ||
| tenantId | body | YES | String | |||
| tenantCode | body | YES | String | |||
| groups | body | NO | Array | Array of strings | ||
| pin | body | NO | Object | |||
| code | YES | Boolean | set to True to create a random generated code | |||
| allowed | YES | Boolean | set to True if this user is allowed to start pin code login | |||
Output
Valid Response
Valid Response Sample
{
"result": true,
"data": {
"..."
}
}
Invalid Response
Error Response Sample
{
"result":false,
"errors":{
"codes":[411],
"details":[
{
"code":411,
"message":"invalid user id provided"
}
]
}
}
Error Codes
Code | Description |
|---|---|
| 405 | Unable to find User. Please try again. |
| 411 | invalid user id provided |
Example (CURL)
Request
Calling Get User API
> CURL -X POST http://127.0.0.1:4000/urac/admin/inviteUser?username=5718a32f0e811ab5a0ca08b3 --data '{"tenantId":"xyz","tenantCode":"xyz", "groups":"[xyz"], "pin":{"code": "123", "allowed": true}}}'
Response
Get User API response
{
"result": true,
"data": true
}
Add Comment