GET - /user

General Information

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

Description

This API gets the information of the user account that has a username or email that matches the one sent in the query as username parameter.

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description
username	Query	YES	String	N/A	Username or email of account

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
520	Unable to find user
602	Model error: + %model_error%