General Information
...
| Service | API | Method |
|---|
| urac | /admin/users/count | GET |
Data Model: Users
Workflow: List Users Flow
Input
...
| Name | Source | Mandatory | Type | Special Format | Description |
|---|
| tId | Body or Query | NO | String | N/A | If set, the api will return the users of a specific tenant; else the api returns all the users in the database |
Output
...
Valid Response
| Code Block |
|---|
| language | js |
|---|
| title | Valid Response Sample |
|---|
|
{
"result": true,
"data": {
"count": 12
}
} |
Invalid Response
| Code Block |
|---|
| language | js |
|---|
| title | Error Response Sample |
|---|
|
{
"result":false,
"errors":{
"codes":[600],
"details":[
{
"code": 600,
"message": "Database connection error"
}
]
}
} |
Error Codes
| |
|---|
| 600 | Database connection error |
Example (CURL)
...
Request
| Code Block |
|---|
| language | bash |
|---|
| title | Calling List Users API |
|---|
|
> CURL -X GET http://127.0.0.1:4000/urac/admin/users/count?tId=5551aca9e179c39b760f7a1a |
Response
| Code Block |
|---|
| language | js |
|---|
| title | List Users API response |
|---|
|
{
"result": true,
"data": {
"count": 12
}
} |