REST API for Unified Assurance Core

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.

conjunction: string

Default Value: OR

Allowed Values: [ "AND", "OR" ]

The conjunction between filters.

Example: AND
operator: string

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
property(required): string

The name of the field to filter on.

Example: name
value(required): string

The value of the field to filter on.

Example: test

{
    "required":[
        "property",
        "value"
    ],
    "properties":{
        "property":{
            "description":"The name of the field to filter on.",
            "type":"string",
            "example":"name"
        },
        "value":{
            "description":"The value of the field to filter on.",
            "type":"string",
            "example":"test"
        },
        "operator":{
            "description":"The filter operation to use.",
            "type":"string",
            "default":"LIKE",
            "enum":[
                "eq",
                "ne",
                "gte",
                "gt",
                "lte",
                "lt",
                "LIKE",
                "NOT LIKE",
                "re",
                "not re",
                "NOT IN"
            ],
            "example":"eq"
        },
        "conjunction":{
            "description":"The conjunction between filters.",
            "type":"string",
            "default":"OR",
            "enum":[
                "AND",
                "OR"
            ],
            "example":"AND"
        }
    },
    "type":"object"
}

limit: integer(int32)
The number of records to limit results by.
Example:
```
100
```

sort: object

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"
}

direction(required): string

Allowed Values: [ "ASC", "DESC" ]

The direction of the sort.

Example: ASC
property(required): string

The field to sort on.

Example: name

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object"
}

start: integer(int32)
The page of results to start from.

Default Value: 0
Example:
```
1
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AAAUsersRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

message: string

The response message.

Example: Loaded 1 entries
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AAAUsersRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object AAAUsersRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AAAUsersRead"
    }
}

Nested Schema : AAAUsersRead

Type: object

Show Source

AccountExpiration: string

Indicates whether a password will expire or not Allowed Values: | [Never] => User's password never expires | immediate => Administrator forced immediate change for this password - user will be required to change at next login | date => User's password will/did expire on the specified $PasswordExpiration date. This value requires $PasswordExpiration to be set.

Example: [Never]
AccountStatus: integer

A flag to indicate if the user account is enabled or disabled. Values- 0 = Disabled, 1 = Enabled

Example: 1
AuthenticationType: object AuthenticationType

The authentication type.
AuthenticationTypeName: string

The authentication type name.

Example: Internal
EmailAddress: string

The user email address.

Example: example@t.c
FailedLoginCount: integer

The number of failed logins.

Example: 0
FullName: string

The full name of the user.

Example: Operator
LastLoginFailed: integer

Last Login Failed

Example: 0
LastLoginSuccess: integer

Last Login Success

Example: 0
Password: string

Required for Internal authentication only

Example:
PasswordExpiration: string

The expiration date of the current password (in YYYYMMDD format).

Example: 2147483647
Preferences: array Preferences

The user preferences.
Properties: array Properties

Properties
RepeatPassword: string

Required for Internal authentication only

Example:
SupportUsername: string

Support User name

Example:
UserGroup: object UserGroup

The user group.
UserGroupName: string

The user group name.

Example: Administrators
UserID: integer

The user ID.

Example: 1065
UserName: string

The user name.

Example: operator

{
    "properties":{
        "UserID":{
            "description":"The user ID.",
            "type":"integer",
            "example":"1065"
        },
        "UserName":{
            "description":"The user name.",
            "type":"string",
            "example":"operator"
        },
        "FullName":{
            "description":"The full name of the user.",
            "type":"string",
            "example":"Operator"
        },
        "EmailAddress":{
            "description":"The user email address.",
            "type":"string",
            "example":"example@t.c"
        },
        "LastLoginSuccess":{
            "description":"Last Login Success",
            "type":"integer",
            "example":"0"
        },
        "LastLoginFailed":{
            "description":"Last Login Failed",
            "type":"integer",
            "example":"0"
        },
        "PasswordExpiration":{
            "description":"The expiration date of the current password (in YYYYMMDD format).",
            "type":"string",
            "example":"2147483647"
        },
        "AccountExpiration":{
            "description":"Indicates whether a password will expire or not\nAllowed Values:\n| [Never]     => User's password never expires\n| immediate => Administrator forced immediate change for this password - user will be required to change at next login\n| date      => User's password will/did expire on the specified $PasswordExpiration date. This value requires $PasswordExpiration to be set.",
            "type":"string",
            "example":"[Never]"
        },
        "FailedLoginCount":{
            "description":"The number of failed logins.",
            "type":"integer",
            "example":"0"
        },
        "AuthenticationType":{
            "description":"The authentication type.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"Unique identifier for the authentication type.",
                    "type":"integer"
                },
                "name":{
                    "description":"Name for the authentication type.",
                    "type":"string"
                }
            },
            "example":{
                "id":"1",
                "name":"Internal"
            }
        },
        "AccountStatus":{
            "description":"A flag to indicate if the user account is enabled or disabled. Values- 0 = Disabled, 1 = Enabled",
            "type":"integer",
            "example":"1"
        },
        "SupportUsername":{
            "description":"Support User name",
            "type":"string",
            "example":""
        },
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string",
            "example":"Administrators"
        },
        "AuthenticationTypeName":{
            "description":"The authentication type name.",
            "type":"string",
            "example":"Internal"
        },
        "UserGroup":{
            "description":"The user group.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"Unique identifier for the user group.",
                    "type":"integer"
                },
                "name":{
                    "description":"Name for the user group.",
                    "type":"string"
                }
            },
            "example":{
                "id":"1",
                "name":"Administrators"
            }
        },
        "Password":{
            "description":"Required for Internal authentication only",
            "type":"string",
            "example":""
        },
        "RepeatPassword":{
            "description":"Required for Internal authentication only",
            "type":"string",
            "example":""
        },
        "Properties":{
            "description":"Properties",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyID":{
                        "description":"Property ID",
                        "type":"integer",
                        "example":"1"
                    },
                    "PreferenceName":{
                        "description":"Property Name",
                        "type":"string",
                        "example":"ResetQuestion"
                    },
                    "PreferenceValue":{
                        "description":"Property Value",
                        "type":"string",
                        "example":"resetval"
                    },
                    "Description":{
                        "description":"Description associated with the Property.",
                        "type":"string",
                        "example":"Reserved for future use"
                    }
                }
            }
        },
        "Preferences":{
            "description":"The user preferences.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PreferenceID":{
                        "description":"The preference ID.",
                        "type":"integer",
                        "example":"3"
                    },
                    "PreferenceName":{
                        "description":"The preference name.",
                        "type":"string",
                        "example":"DefaultDisplayID"
                    },
                    "PreferenceValue":{
                        "description":"The preference value.",
                        "type":"string",
                        "example":"5"
                    },
                    "Description":{
                        "description":"The preference description.",
                        "type":"string",
                        "example":"Default event list display (default &quot;Default&quot;)"
                    },
                    "Override":{
                        "description":"This flag indicates if the user's group preference overrides the user's specific preference.",
                        "type":"integer",
                        "example":0
                    }
                }
            }
        }
    }
}

Nested Schema : AuthenticationType

Type: object

The authentication type.

Show Source

id: integer

Unique identifier for the authentication type.
name: string

Name for the authentication type.

{
    "description":"The authentication type.",
    "type":"object",
    "properties":{
        "id":{
            "description":"Unique identifier for the authentication type.",
            "type":"integer"
        },
        "name":{
            "description":"Name for the authentication type.",
            "type":"string"
        }
    },
    "example":{
        "id":"1",
        "name":"Internal"
    }
}

Example:

{
    "id":"1",
    "name":"Internal"
}

Nested Schema : Preferences

Type: array

The user preferences.

Show Source

Array of: object items

{
    "description":"The user preferences.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PreferenceID":{
                "description":"The preference ID.",
                "type":"integer",
                "example":"3"
            },
            "PreferenceName":{
                "description":"The preference name.",
                "type":"string",
                "example":"DefaultDisplayID"
            },
            "PreferenceValue":{
                "description":"The preference value.",
                "type":"string",
                "example":"5"
            },
            "Description":{
                "description":"The preference description.",
                "type":"string",
                "example":"Default event list display (default &quot;Default&quot;)"
            },
            "Override":{
                "description":"This flag indicates if the user's group preference overrides the user's specific preference.",
                "type":"integer",
                "example":0
            }
        }
    }
}

Nested Schema : Properties

Type: array

Properties

Show Source

Array of: object items

{
    "description":"Properties",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyID":{
                "description":"Property ID",
                "type":"integer",
                "example":"1"
            },
            "PreferenceName":{
                "description":"Property Name",
                "type":"string",
                "example":"ResetQuestion"
            },
            "PreferenceValue":{
                "description":"Property Value",
                "type":"string",
                "example":"resetval"
            },
            "Description":{
                "description":"Description associated with the Property.",
                "type":"string",
                "example":"Reserved for future use"
            }
        }
    }
}

Nested Schema : UserGroup

Type: object

The user group.

Show Source

id: integer

Unique identifier for the user group.
name: string

Name for the user group.

{
    "description":"The user group.",
    "type":"object",
    "properties":{
        "id":{
            "description":"Unique identifier for the user group.",
            "type":"integer"
        },
        "name":{
            "description":"Name for the user group.",
            "type":"string"
        }
    },
    "example":{
        "id":"1",
        "name":"Administrators"
    }
}

Example:

{
    "id":"1",
    "name":"Administrators"
}

Nested Schema : items

Type: object

Show Source

Description: string

The preference description.

Example: Default event list display (default "Default")
Override: integer

This flag indicates if the user's group preference overrides the user's specific preference.

Example: 0
PreferenceID: integer

The preference ID.

Example: 3
PreferenceName: string

The preference name.

Example: DefaultDisplayID
PreferenceValue: string

The preference value.

Example: 5

{
    "type":"object",
    "properties":{
        "PreferenceID":{
            "description":"The preference ID.",
            "type":"integer",
            "example":"3"
        },
        "PreferenceName":{
            "description":"The preference name.",
            "type":"string",
            "example":"DefaultDisplayID"
        },
        "PreferenceValue":{
            "description":"The preference value.",
            "type":"string",
            "example":"5"
        },
        "Description":{
            "description":"The preference description.",
            "type":"string",
            "example":"Default event list display (default &quot;Default&quot;)"
        },
        "Override":{
            "description":"This flag indicates if the user's group preference overrides the user's specific preference.",
            "type":"integer",
            "example":0
        }
    }
}

Nested Schema : items

Type: object

Show Source

Description: string

Description associated with the Property.

Example: Reserved for future use
PreferenceName: string

Property Name

Example: ResetQuestion
PreferenceValue: string

Property Value

Example: resetval
PropertyID: integer

Property ID

Example: 1

{
    "type":"object",
    "properties":{
        "PropertyID":{
            "description":"Property ID",
            "type":"integer",
            "example":"1"
        },
        "PreferenceName":{
            "description":"Property Name",
            "type":"string",
            "example":"ResetQuestion"
        },
        "PreferenceValue":{
            "description":"Property Value",
            "type":"string",
            "example":"resetval"
        },
        "Description":{
            "description":"Description associated with the Property.",
            "type":"string",
            "example":"Reserved for future use"
        }
    }
}

Default Response

Failed operation

Root Schema : schema

Type: object

Show Source

errors: array errors

The list of errors reported. Validation errors will be keyed by record field.
message: string

The response message.

Example: Exception thrown
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object