Summary
Get all accounts from Local AAA instance.
Description
Get all accounts from Local AAA instance in IAP.
Route
GET /user-management/accounts
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
Options for query parameters. |
Copied to Clipboard
{
"queryOptions": null
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"contains": {
"type": "string",
"examples": [
"john_doe"
]
},
"containsField": {
"type": "string",
"examples": [
"username"
]
},
"equals": {
"type": "string",
"examples": [
"john_doe"
]
},
"equalsField": {
"type": "string",
"examples": [
"username"
]
},
"startsWith": {
"type": "string",
"examples": [
"john_doe"
]
},
"startsWithField": {
"type": "string",
"examples": [
"username"
]
},
"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 |
Contains an array of accounts, the applied skip/limit, and the total in the response. |
Copied to Clipboard
{
"result": true
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"examples": [
"5dd2cdab94410956f3ecbc79"
]
},
"provenance": {
"type": "string",
"examples": [
"Local AAA"
]
},
"username": {
"type": "string",
"examples": [
"john_doe"
]
},
"firstname": {
"type": "string",
"examples": [
"john"
]
},
"memberOf": {
"type": "array",
"items": {
"type": "object",
"properties": {
"groupId": {
"type": "string",
"examples": [
"5dd2cdab94410956f3ecbc79"
]
},
"aaaManaged": {
"type": "boolean",
"enum": [
true
]
}
}
}
},
"lastLogin": {
"type": "string",
"examples": [
"2020-10-26T15:17:17.582Z"
]
},
"inactive": {
"type": "boolean",
"enum": [
true,
false
]
},
"_meta": {
"type": "object",
"properties": {
"created": {
"type": "string",
"examples": [
"2020-10-26T15:17:17.582Z"
]
},
"updated": {
"type": "string",
"examples": [
"2020-10-26T15:17:17.582Z"
]
},
"migrationVersion": {
"type": "integer",
"examples": [
1
]
}
}
}
}
}
},
"skip": {
"$ref": "common-schema#/definitions/skip"
},
"limit": {
"$ref": "common-schema#/definitions/limit"
},
"total": {
"$ref": "common-schema#/definitions/total"
}
}
}
