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
-
filter: object
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
-
conjunction:
string
-
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
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : AAAUsersRead
Type:
Show Source
object
-
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 = EnabledExample:
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 FailedExample:
0
-
LastLoginSuccess: integer
Last Login SuccessExample:
0
-
Password: string
Required for Internal authentication onlyExample:
-
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 onlyExample:
-
SupportUsername: string
Support User nameExample:
-
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
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.
Example:
{
"id":"1",
"name":"Internal"
}
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.
Example:
{
"id":"1",
"name":"Administrators"
}
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : items
Type:
Show Source
object
-
Description: string
Description associated with the Property.Example:
Reserved for future use
-
PreferenceName: string
Property NameExample:
ResetQuestion
-
PreferenceValue: string
Property ValueExample:
resetval
-
PropertyID: integer
Property IDExample:
1
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
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