General Information
...
| Service | API | Method | Data Models | Workflow |
|---|---|---|---|---|
| urac | /admin/users/count | GET |
Data Model: Users
Description
This API counts users based on keywords. These keywords will be compared to usernames, emails, first names, and last names in the database.
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| keywords | Query | NO | String | N/A | Applied towards: email, username, firstName, or lastName |
| scope | Query | NO | String | enum ["myTenancy", "otherTenancy"] | This is available when main tenant roaming is enabled. Please note that this is available starting Stingray release |
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result": true,
"data": { "count"data: 122
}
} |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[400602],
"details":[
{
"code": 400602,
"message":"Model "Databaseerror: connection+ error%model_error%"
}
]
}
} |
...
Code | Description |
|---|---|
| 400 |
Database connection errorRequest
| Code Block | ||||
|---|---|---|---|---|
| ||||
> CURL -X GET http://127.0.0.1:4000/urac/admin/users/count |
Response
...
| language | js |
|---|---|
| title | List Users API response |
Business logic required data are missing | |
| 602 | Model error: + %model_error% |