GET - /admin/users/ids

General Information

Service	API	Method	Data Model	Workflow
urac	/admin/users/ids	GET	Users	List Users Flow

Description

This API lists users that have a matching id from the array of ids sent in the query.

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description
ids	Query	YES	String	N/A	Users IDs
config	Query	NO	Object	N/A	Configuration Object

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%