Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/account/getUserGET


Data Model: Users

Workflow: %Link to Architecture Page% Get User Account Flow

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
usernameQueryYESStringN/AThe User Name

 


Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": {
		"..."	
	}
}

...


Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[405],
        "details":[
            {
                "code":405,
                "message":"Unable to find User. Please try again."
            }
        ]
    }
}



Error Codes



 

Code
Description
405Unable to find User. Please try again.


Example (CURL)

...

Request

Code Block
languagebash
titleCalling getUser Get User API
 > CURL -X GET http://127.0.0.1:4000/urac/account/getUser?username=john 

...

Code Block
languagejs
titlegetUser Get User API response
{
	"result": true,
	"data": {
		"_id": "571a2a0e8cc861b98a0b9467",
		"locked": true,
		"username": "john",
		"firstName": "john",
		"lastName": "john",
		"email": "john@soajs.org",
		"ts": 1461332494711,
		"status": "active",
		"profile": {},
		"groups": ["administrator"],
		"config": {
			"packages": {},
			"keys": {}
		},
		"tenant": {
			"id": "5551aca9e179c39b760f7a1a",
			"code": "DBTN"
		}
	}
}

...