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

Update a User

put

/api/AAA/Users/{id}

Updates the properties of the user that matches the specified ID.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Details of the user to create or update.
Show Source
  • The date when the account's password will expire. Set to 0 for never, or a date/time string in a format parsable by the strtotimeM PHP function.
    Example: [Never]
  • A flag to indicate if the user account is enabled or disabled. Possible values are 0 for disabled or 1 for enabled.
    Example: 1
  • Unique identifier for the authentication type instance.
    Example: 1
  • The user email address.
    Example: example@example.com
  • The full name of the user.
    Example: Operator
  • The user's password. Required for Internal authentication only.
    Example:
  • When the user's password will expire. Set either this or PasswordExpiration, not both.
    Allowed values are:
    • never: The password never expires.
    • immediate: The password expires the next time the user logs in, and they must reset it immediately.
    • YYYY-MM-DD: The date when the password expires.
    Example: date
  • The UNIX timestamp when the user's password will expire. Set either this or PasswordChange, not both. 0 means immediate, 2147483647 means never.
    Example: 2147483647
  • Preferences
    The user preferences.
  • Properties
    The user's properties.
  • The user's password, repeated. Required for Internal authentication only.
    Example:
  • Subgroups
    A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences. The same group cannot appear in both the UserGroup (primary) and Subgroups list for the user.
  • The Unified Assurance support site password.
    Example:
  • The support user name.
    Example:
  • The unique identifier for the primary user group from which the user inherits configurations, including roles, properties, and preferences.
    Example: 1
  • The username.
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.
    Example: operator
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. The same group cannot appear in both the UserGroup (primary) and Subgroups list for the user.
Example:
[2, 1001]
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • The description of the property.
    Example: Reserved for future use
  • Example: 2
  • The property ID.
    Example: 1
  • The property name.
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.
    Example: ResetQuestion
  • The property value.
    Example: resetval
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulUpdateOperation
Type: object
The response body for a successful update 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