Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AAAUsersRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

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

{
    "description":"The response body for a successful get operation.",
    "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

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

Nested Schema : data

Type: array

Show Source

• Array of: object AAAUsersRead
  User details.

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

Nested Schema : AAAUsersRead

Type: object

User details.

Show Source

• AccountExpiration: string
  The date when the account's password will expire. 0 means it never expires.

  Example: [Never]
• AccountStatus: integer
  A flag to indicate if the user account is enabled (1) or disabled (0).

  Example: 1
• AuthenticationType: object AuthenticationType
  The authentication type instance for the user..
• AuthenticationTypeName: string
  The authentication type instance name.

  Example: Internal
• EmailAddress: string
  The user email address.

  Example: [e-mail]
• FailedLoginCount: integer
  The number of failed logins.

  Example: 0
• FullName: string
  The full name of the user.

  Example: Operator
• LastLoginFailed: integer
  The last failed login attempt.

  Example: 0
• LastLoginSuccess: integer
  The last successful login attempt.

  Example: 0
• Password: string
  The user's password. Required for Internal authentication only.

  Example:
• PasswordExpiration: string
  The UNIX timestamp when the password will expire. 0 means it has expired.

  Example: 2147483647
• Preferences: array Preferences
  The user preferences.
• Properties: array Properties
  The user's properties.
• RepeatPassword: string
  The user's password, repeated. Required for Internal authentication only.

  Example:
• Subgroups: array Subgroups
  A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences.
• SupportUsername: string
  The 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":"[e-mail]"
        },
        "LastLoginSuccess":{
            "description":"The last successful login attempt.",
            "type":"integer",
            "example":"0"
        },
        "LastLoginFailed":{
            "description":"The last failed login attempt.",
            "type":"integer",
            "example":"0"
        },
        "PasswordExpiration":{
            "description":"The UNIX timestamp when the password will expire. <b>0</b> means it has expired.",
            "type":"string",
            "example":"2147483647"
        },
        "AccountExpiration":{
            "description":"The date when the account's password will expire. <b>0</b> means it never expires.",
            "type":"string",
            "example":"[Never]"
        },
        "FailedLoginCount":{
            "description":"The number of failed logins.",
            "type":"integer",
            "example":"0"
        },
        "AuthenticationType":{
            "description":"The authentication type instance for the user..",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The unique identifier for the authentication type instance.",
                    "type":"integer"
                },
                "name":{
                    "description":"The name for the authentication type instance.",
                    "type":"string"
                }
            },
            "example":{
                "id":"1",
                "name":"Internal"
            }
        },
        "AccountStatus":{
            "description":"A flag to indicate if the user account is enabled (<b>1</b>) or disabled (<b>0</b>).",
            "type":"integer",
            "example":"1"
        },
        "SupportUsername":{
            "description":"The support user name.",
            "type":"string",
            "example":""
        },
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string",
            "example":"Administrators"
        },
        "AuthenticationTypeName":{
            "description":"The authentication type instance name.",
            "type":"string",
            "example":"Internal"
        },
        "UserGroup":{
            "description":"The user group.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The unique identifier for the primary user group from which the user inherits configurations which includes roles, properties, and preferences.",
                    "type":"integer"
                },
                "name":{
                    "description":"The user group name.",
                    "type":"string"
                }
            },
            "example":{
                "id":"1",
                "name":"Administrators"
            }
        },
        "Subgroups":{
            "description":"A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences.",
            "type":"array",
            "example":"[2, 1001]"
        },
        "Password":{
            "description":"The user's password. Required for Internal authentication only.",
            "type":"string",
            "example":""
        },
        "RepeatPassword":{
            "description":"The user's password, repeated. Required for Internal authentication only.",
            "type":"string",
            "example":""
        },
        "Properties":{
            "description":"The user's properties.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyID":{
                        "description":"The property ID.",
                        "type":"integer",
                        "example":"1"
                    },
                    "PropertyName":{
                        "description":"The property name.",
                        "type":"string",
                        "example":"ResetQuestion"
                    },
                    "PropertyValue":{
                        "description":"The property value.",
                        "type":"string",
                        "example":"resetval"
                    },
                    "Description":{
                        "description":"The 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 'Default')"
                    },
                    "Override":{
                        "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
                        "type":"integer",
                        "example":0
                    }
                }
            }
        }
    },
    "description":"User details."
}

Nested Schema : AuthenticationType

Type: object

The authentication type instance for the user..

Show Source

• id: integer
  The unique identifier for the authentication type instance.
• name: string
  The name for the authentication type instance.

{
    "description":"The authentication type instance for the user..",
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the authentication type instance.",
            "type":"integer"
        },
        "name":{
            "description":"The name for the authentication type instance.",
            "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 'Default')"
            },
            "Override":{
                "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
                "type":"integer",
                "example":0
            }
        }
    }
}

Nested Schema : Properties

Type: array

The user's properties.

Show Source

• Array of: object items

{
    "description":"The user's properties.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyID":{
                "description":"The property ID.",
                "type":"integer",
                "example":"1"
            },
            "PropertyName":{
                "description":"The property name.",
                "type":"string",
                "example":"ResetQuestion"
            },
            "PropertyValue":{
                "description":"The property value.",
                "type":"string",
                "example":"resetval"
            },
            "Description":{
                "description":"The description associated with the property.",
                "type":"string",
                "example":"Reserved for future use"
            }
        }
    }
}

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

• id: integer
  The unique identifier for the primary user group from which the user inherits configurations which includes roles, properties, and preferences.
• name: string
  The user group name.

{
    "description":"The user group.",
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the primary user group from which the user inherits configurations which includes roles, properties, and preferences.",
            "type":"integer"
        },
        "name":{
            "description":"The user group name.",
            "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
  Whether the preference is unlocked (0), allowing the user to override their group preference, or locked (1), preventing the user from overriding it.

  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 'Default')"
        },
        "Override":{
            "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
            "type":"integer",
            "example":0
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Description: string
  The description associated with the property.

  Example: Reserved for future use
• PropertyID: integer
  The property ID.

  Example: 1
• PropertyName: string
  The property name.

  Example: ResetQuestion
• PropertyValue: string
  The property value.

  Example: resetval

{
    "type":"object",
    "properties":{
        "PropertyID":{
            "description":"The property ID.",
            "type":"integer",
            "example":"1"
        },
        "PropertyName":{
            "description":"The property name.",
            "type":"string",
            "example":"ResetQuestion"
        },
        "PropertyValue":{
            "description":"The property value.",
            "type":"string",
            "example":"resetval"
        },
        "Description":{
            "description":"The description associated with the property.",
            "type":"string",
            "example":"Reserved for future use"
        }
    }
}

Default Response

Failed operation

Body ()

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":{
                "description":"An error.",
                "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
  An error.

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

Nested Schema : items

Type: object

An error.

Back to Top