GET - /admin/users

General Information

Service	API	Method	Data Models	Workflow
urac	/admin/users	GET	Users	Get Users Flow

Description

This API lists users based on keywords. These keywords will be compared to usernames, emails, first names, and last names in database.

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description
config	Query	NO	Object	N/A	Config Object
start	Query	NO	Number	N/A	The start index of the records to get. Default 0
limit	Query	NO	Number	N/A	The number of records to get. Default 1000
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

Valid Response Sample

{ 
  result: true,
  data: [
  {
    "_id": "5c8d0c505653de3985aa0ffd",
    "locked": true,
    "username": "johnd",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@localhost.com",
    "ts": 1552747600152,
    "status": "active",
    "profile": {},
    "groups": [
      "AAAA"
    ],
    "config": {
      "packages": {},
      "keys": {},
      "allowedTenants": []
    },
    "tenant": {
      "id": "5d9321f8b40e09438afbd0c9",
      "code": "test",
      "pin": {
        "allowed": true
      }
    }
  }
]
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description
400	Business logic required data are missing
602	Model error: + %model_error%