Versions Compared

Key

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

General Information

...

NameSourceMandatoryTypeSpecial FormatDescription
tIdQueryNOStringN/AIf set, the api will return the users of a specific tenant; else the api returns all the users in the database
startQueryNONumberN/AThe start index of the records to get. Default 0
limitQueryNONumberN/AThe number of records to get. Default 1000


Output

...

Valid Response

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

...

Code Block
languagejs
titleList 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"],
		"config": {
			"packages": {},
			"keys": {}
		},
		"tenant": {
			"id": "5551aca9e179c39b760f7a1a",
			"code": "DBTN"
		}
	}
	]
}