Get a User by ID
get
/api/AAA/Users/{id}
Gets the user that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The user ID.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 : 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