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