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.
Field | Details | Description |
---|---|---|
defaultPartition | object (Partition ) | Object: - uuid - name |
description | string | A description of the role. |
email | string <email> | The email address for the use . |
fullName | string | The full name of the user. |
isDisabled | boolean | Search for enabled vs disabled users. Example: isDisabled=false |
isDisabled | boolean | The flag that disables a user. Default: null |
isServiceAccount | boolean | The flag that identifies a service account. Default: null |
isSSOUser | boolean | The flag that identifies a single sign-on user. Default: null |
locale | string | The user's locale. |
name | string | The name of the partition. |
name | string | The name of the role. |
partition | Required object (Partition) | Object: - uuid - name |
partitionRoles | Array of objects (PartitionRole) | Array: - partition - roles |
partitionUUID | string <uuid> | Search for users in this partition. Example: partitionUUID=37f038e2-22ec-4e5b-93f4-f065bea65542 |
password | string | The user's password. |
passwordExpirationDateMaximum | string <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 |
passwordExpirationDateMinimum | string <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 |
passwordExpirationDate | string <date> | The password expiration date for the user. |
passwordExpirationDisabled | boolean | The flag that disables password expiration for a user. Default: null |
roles | Required Array of objects (Role) | Array: - uuid - sourceId - name - description |
roleUUID | string <uuid> | Search for users with specific role UUID. Example: roleUUID=37f038e2-22ec-4e5b-93f4-f065bea65542 |
sourceId | integer <int64> | The source ID for the role. Default: null |
username | string | The username of the user . Example: [email protected] |
username | string | The username of the user |
uuid | Required string <uuid> | The UUID for the partition. |
uuid | Required string <uuid> | The UUID for the role. |
uuid | Required string <uuid> | The UUID of the user to update Example: 37f038e2-22ec-4e5b-93f4-f065bea65542 |
Updated 2 months ago