User Management and Role Management API Fields

Learn about the fields in the O Series User Management and Role Management APIs.

User Management and Role Management fields

This table lists the fields included in the request body for O Series On-Premise and On-Demand User Management and Role Management API requests.

User and Role fieldUser and Role field detailsUser and Role field description
defaultPartitionobject (Partition)

Object:

- uuid
- name

descriptionstringA description of the role.
emailstring <email>The email address for the use .
fullNamestringThe full name of the user.
isDisabledboolean

Search for enabled vs disabled users.

Example: isDisabled=false

isDisabledboolean

The flag that disables a user.

Default: null

isServiceAccountboolean

The flag that identifies a service account.

Default: null

isSSOUserboolean

The flag that identifies a single sign-on user.

Default: null

localestringThe user's locale.
namestringThe name of the partition.
namestringThe name of the role.
partitionRequired
object (Partition)

Object:

- uuid
- name

partitionRolesArray of objects (PartitionRole)

Array:

- partition
- roles

partitionUUIDstring <uuid>

Search for users in this partition.

Example: partitionUUID=37f038e2-22ec-4e5b-93f4-f065bea65542

passwordstringThe user's password.
passwordExpirationDateMaximumstring <date>

Search for users with a password expiration date less than or equal to the specified date.

Example: passwordExpirationDateMaximum=2020-01-01T00:00:00.000Z

passwordExpirationDateMinimumstring <date>

Search for users with a password expiration date greater than or equal to the specified date.

Example: passwordExpirationDateMinimum=2020-01-01T00:00:00.000Z

passwordExpirationDatestring <date>The password expiration date for the user.
passwordExpirationDisabledboolean

The flag that disables password expiration for a user.

Default: null

rolesRequired
Array of objects (Role)

Array:

- uuid
- sourceId
- name
- description

roleUUIDstring <uuid>

Search for users with specific role UUID.

Example: roleUUID=37f038e2-22ec-4e5b-93f4-f065bea65542

sourceIdinteger <int64>

The source ID for the role.

Default: null

usernamestring

The username of the user .

Example: [email protected]

usernamestringThe username of the user
uuidRequired
string <uuid>
The UUID for the partition.
uuidRequired
string <uuid>
The UUID for the role.
uuidRequired
string <uuid>

The UUID of the user to update

Example: 37f038e2-22ec-4e5b-93f4-f065bea65542