Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/admin/getUser
Get
GET


Data Model: %Link to Data Model% Users

Workflow: %Link to Architecture Page% Get User Flow

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
 
uId
Body
QueryYESStringN/A
 

...

the user id


Output

...

Valid Response

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

...


Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[400411],
        "details":[
            {
                "code":400411,
                "message":"Probleminvalid withuser theid provided password"
            }
        ]
    }
}



Error Codes

 



Code
Description
400Database Error
405Unable to find User. Please try again.
411invalid user id provided


Example (CURL)

...

Request

Code Block
languagebash
titleCalling YOUR Get User API
 > CURL -X POSTGET http://127.0.0.1:4000/...urac/admin/getUser?uId=5718a32f0e811ab5a0ca08b3 

Response

Code Block
languagejs
titleYOUR Get User API response
{
	    "result": true,
    	"data": {
		
        "_id": ObjectId('5718a32f0e811ab5a0ca08b3'),
        "locked": true,
  "57063608622c47b5c097d19b",
		"..."
	      "username": "owner",
        "password": "$2a$04$GfQ/6TJX82HcCoq8z8R44uN6x38hmJVIh7sKXIxknjt9UjN/f90sy",
        "firstName": "owner",
        "lastName": "owner",
        "email": "owner@soajs.org",
        "ts": 1461232431542,
        "status": "active",
        "profile": {},
        "groups": [
            "owner"
        ],
        "config": {
            "packages": {},
            "keys": {}
        },
        "tenant": {
            "id": "5551aca9e179c39b760f7a1a",
            "code": "DBTN"
        }
    }
}