Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

General Information

...

ServiceAPIMethodData ModelsWorkflow
urac/admin/allGETUsers & GroupsGet Users Flow

Description

This API lists all the user and group records that exist in the tenant that has the external key sent in the request headers.

Input

...

Type: application/json

This API doesn't require input.


Output

...

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Code Block
languagejs
titleValid Response Sample
linenumberstrue
collapsetrue
{
  "result": true,
  "data": {
    "users": [
      {
        "_id": "5da57ff8abd7b1027390ef45",
        "locked": true,
        "username": "change",
        "firstName": "mail",
        "lastName": "service",
        "email": "change@mail.com",
        "ts": 1552747600152,
        "status": "active",
        "profile": {},
        "groups": [
          "dev"
        ],
        "config": {
          "packages": {},
          "keys": {},
          "allowedTenants": []
        },
        "tenant": {
          "id": "5d9321f8b40e09438afbd0c9",
          "code": "test",
          "pin": {
            "allowed": true
          }
        }
      }
    ],
    "groups": [
      {
        "_id": "5d95da834dcd8a4d1d822ef5",
        "code": "AAAA",
        "name": "Unit test",
        "description": "Added by unit test importer.",
        "config": {
          "allowedPackages": {
            "DSBRD": [
              "DSBRD_DEVOP"
            ]
          },
          "allowedEnvironments": {
            "DEV": {},
            "DEVOP": {}
          }
        },
        "tenant": {
          "id": "5d9321f8b40e09438afbd0c9",
          "code": "test",
          "pin": {
            "code": "1235",
            "allowed": true
          }
        }
      }
    ]
  }
}

Invalid Response

Code Block
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "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

602Model error: + %model_error%