Summary
Get all accounts.
Description
Get all accounts
Route
GET /authorization/accounts
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
The query options for searching accounts. |
Copied to Clipboard
{
"queryOptions": {
"multiContains": {
"username": "john_doe",
"firstname": "John",
"email": "user@email.com",
"provenance": "Local AAA"
},
"multiEquals": {
"username": "john_doe",
"firstname": "John",
"email": "user@email.com",
"provenance": "Local AAA"
},
"multiStartsWith": {
"username": "john_doe",
"firstname": "John",
"email": "user@email.com",
"provenance": "Local AAA"
},
"inactive": true,
"isServiceAccount": true,
"groupId": "5cb7b531d06cceb89fd21b1c",
"skip": 10,
"limit": 50,
"sort": "name",
"order": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"multiContains": {
"$ref": "authorization-common#/definitions/accounts-query"
},
"multiEquals": {
"$ref": "authorization-common#/definitions/accounts-query"
},
"multiStartsWith": {
"$ref": "authorization-common#/definitions/accounts-query"
},
"inactive": {
"$ref": "accounts-schema#/definitions/inactive"
},
"isServiceAccount": {
"$ref": "accounts-schema#/definitions/isServiceAccount"
},
"groupId": {
"$ref": "common-schema#/definitions/objectId"
},
"skip": {
"$ref": "common-schema#/definitions/skip"
},
"limit": {
"$ref": "common-schema#/definitions/limit"
},
"sort": {
"$ref": "common-schema#/definitions/sort"
},
"order": {
"$ref": "common-schema#/definitions/order"
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The accounts matching the specified query. |
Copied to Clipboard
{
"results": {
"provenance": "Local AAA",
"username": "john_doe",
"firstname": "John",
"memberOf": [
{
"aaaManaged": true,
"groupId": "5cb7b531d06cceb89fd21b1c"
}
],
"assignedRoles": [
{
"roleId": "5cb7b531d06cceb89fd21b1c"
},
{
"roleId": "5cb7b531d06cceb89fd21b1c"
},
{
"roleId": "5cb7b531d06cceb89fd21b1c"
},
{
"roleId": "5cb7b531d06cceb89fd21b1c"
},
{
"roleId": "5cb7b531d06cceb89fd21b1c"
}
],
"inactive": true,
"lastLogin": "2018-08-02T15:56:12.912Z",
"_meta": {
"created": "2018-08-02T15:56:12.912Z",
"updated": "2018-08-02T15:56:12.912Z"
},
"email": "name@email.com",
"isServiceAccount": true
},
"total": 50
}
