List Users

General Information

Service	API	Method

Service	API	Method
urac	/admin/listUsers	GET

Data Model: Users

Workflow: List Users Flow

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description

Name	Source	Mandatory	Type	Special Format	Description
uId	Query	NO	String	N/A	If set, the api will return the users of a specific tenant; else the api returns all the users in the database
start	Query	NO	Number	N/A	The start index of the records to get. Default 0
limit	Query	NO	Number	N/A	The number of records to get. Default 1000
keywords	Query\|\|Body	NO	String		applied towards `let rePattern = new RegExp(req.soajs.inputmaskData['keywords'], 'i');` `condition['$or'] = [` `{"email": rePattern},` `{"username": rePattern},` `{"firstName": rePattern},` `{"lastName": rePattern}` `];`

Output

Valid Response

Valid Response Sample

{
	"result": true,
	"data": [{
			"..."
		},
		// ...
	]
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[400],
        "details":[
            {
                "code":400,
                "message":"Database connection error"
            }
        ]
    }
}

Error Codes

Code	Description

Code	Description
400	Database connection error

Example (CURL)

Request

Calling List Users API

> CURL -X GET http://127.0.0.1:4000/urac/admin/listUsers?tId=5551aca9e179c39b760f7a1a

Response

List Users API response

{
	"result": true,
	"data": [
	{
		"_id": "571a2a0e8cc861b98a0b9467",
		"locked": true,
		"username": "owner",
		"firstName": "owner",
		"lastName": "owner",
		"email": "owner@soajs.org",
		"ts": 1461332494711,
		"status": "active",
		"profile": {},
		"groups": ["owner"],
		"tenant": {
			"id": "5551aca9e179c39b760f7a1a",
			"code": "DBTN"
		}
	}
	]
}