1. REST API for Unified Assurance Core
  2. Tasks
  3. AAA
  4. Users

Get Users

get

/api/AAA/Users

Gets the users that match the specified parameters. If no parameters are specified, all users are returned.

Request

Query Parameters
  • The fields to filter the results by. You cannot filter by fields that contain a state.
    This parameter's value uses the following JSON format:
    { "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
    If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.
    • Default Value: OR
      Allowed Values: [ "AND", "OR" ]
      The conjunction between filters.
      Example: AND
    • Default Value: LIKE
      Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
      The filter operation to use.
      Example: eq
    • The name of the field to filter on.
      Example: name
    • The value of the field to filter on.
      Example: test
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • The field and direction to sort results by. You cannot sort by fields that contain a state.
    This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }
    Example:
    [
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : AAAUsersRead
Type: object
User details.
Show Source
Nested Schema : AuthenticationType
Type: object
The authentication type instance for the user..
Show Source
Example:
{
    "id":"1",
    "name":"Internal"
}
Nested Schema : Preferences
Type: array
The user preferences.
Show Source
Nested Schema : Properties
Type: array
The user's properties.
Show Source
Nested Schema : Subgroups
Type: array
A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences.
Example:
[2, 1001]
Nested Schema : UserGroup
Type: object
The user group.
Show Source
  • The unique identifier for the primary user group from which the user inherits configurations which includes roles, properties, and preferences.
  • The user group name.
Example:
{
    "id":"1",
    "name":"Administrators"
}
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : errors
Type: array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type: object
An error.
Back to Top