User

The values stored for a user. This structure is passed when creating or modifying a user. It is returned when querying a user.

Properties

Name	Type	Description	Notes
alternate_emails	List[UserAlternateEmails]	A list of all the users alternate emails.	[optional]
authenticator_lockout_status	List[UserAuthenticatorLockoutStatus]	A list of all authenticators that the user has with their lockout status.	[optional]
directory_dn	str	The DN of the user in the directory the user was synchronized from.	[optional]
directory_id	str	If the user was synchronized from a directory, the UUID of that directory.	[optional]
directory_name	str	If the user was synchronized from a directory, the name of that directory.	[optional]
directory_object_guid	str	The objectGUID of the user in the directory the user was synchronized from.	[optional]
directory_type	str	The type of the directory user was synchronized from.	[optional]
email	str	The email address of this user. This value may or may not be required depending on configuration. It must be set to use EMAIL OTP authentication and other features that require an email address.	[optional]
external_id	str	An optional external ID for this user. This value can be used to track the external identity of an Identity as a Service user.	[optional]
external_source	str	An optional value that describes the source when the user is synchronized from an external source.	[optional]
fido_tokens	List[FIDOToken]	A list of all the FIDO tokens owned by this user.	[optional]
first_name	str	The first name of this user. This value may or may not be required depending on configuration.	[optional]
frozen	bool	Indicates whether a user is unable to authenticate due to inactivity.	[optional]
frozen_grace_period	datetime	Indicates a user's frozen grace period.	[optional]
grids	List[Grid]	A list of all the grids owned by this user.	[optional]
groups	List[Group]	A list of all groups to which this user belongs.	[optional]
id	str	The unique UUID for this user. This value is generated by the service when a user is created.	[optional]
last_auth_time	datetime	The last time this user successfully authenticated. Null if the user has never authenticated.	[optional]
last_modified	datetime	When the user was last modified.	[optional]
last_name	str	The last name of this user. This value may or may not be required depending on configuration.	[optional]
locale	str	The locale of this user. If not set, the default account locale will be used.	[optional]
locked	bool	A flag indicating if this user is locked.	[optional]
locked_authenticator_types	List[str]	The user authenticators that are locked.	[optional]
locked_authenticators	List[str]	The user authenticators that are locked. Deprecated: use lockedAuthenticatorTypes	[optional]
lockout_expiry	datetime	If the user is locked, this value will specify the time at which the lockout will expire.	[optional]
magic_link_enabled	bool	Indicates whether Magic Links are enabled for this user.	[optional]
migrated	bool	A flag indicating if this user was migrated from Entrust IdentityGuard.	[optional]
mobile	str	The mobile number of this user. This value may or may not be required depending on configuration. It must be set to use SMS OTP authentication.	[optional]
oauth_roles	List[OAuthRole]	A list of all oauth roles to which this user belongs.	[optional]
organizations	List[Organization]	A list of the user organizations.	[optional]
otp_create_time	datetime	If the user has an OTP, this attribute specifies when the user's OTP was created.	[optional]
password_expiration_time	datetime	The password expiration time.	[optional]
phone	str	The phone number of this user. This value may or may not be required depending on configuration. It must be set to use VOICE OTP authentication.	[optional]
preferred_otp_delivery	str	Preferred OTP delivery type (SMS, EMAIL or VOICE) or SYSTEM to use the system defined default.	[optional]
preferred_otp_delivery_contact_attributes	Dict[str, str]	Preferred OTP delivery contact attribute for the given type (i.e., OTP_EMAIL, OTP_SMS, OTP_VOICE. An empty string means no override for that type).	[optional]
registration_enabled	bool	Indicates whether registration is enabled for this user.	[optional]
registration_required	bool	Indicates whether self-registration is required. This attribute doesn't apply to administrators.	[optional]
security_id	str	The security ID of this user. The security ID is a unique value used to identity the user when performing smart card login to Microsoft Windows.	[optional]
show_notification	bool	Indicates whether to show notifications to this user.	[optional]
smart_credentials	List[SmartCredential]	A list of all the smart credentials owned by this user.	[optional]
state	str	The state of this user. Only users in the ACTIVE state can perform authentication.	[optional]
temp_access_code	TempAccessCode		[optional]
tokens	List[Token]	A list of all the tokens owned by this user.	[optional]
type	str	The type of user. A value of LDAP_AD means the user was synchronized from a directory. A value of MGMT_UI means the user was created in Identity as a Service. A value of EXTERNAL means the user was synchronized from an external source.	[optional]
user_aliases	List[UserAlias]	A list of user aliases for this user.	[optional]
user_attribute_values	List[UserAttributeValue]	A list of user attribute values for this user.	[optional]
user_creation_time	datetime	The time this user was created.	[optional]
user_extra_attributes	List[UserExtraAttribute]	A list of extra optional attributes for this user.	[optional]
user_id	str	The user ID for this user.	[optional]
user_principal_name	str	The user principal name of this user. This value may or may not be required depending on configuration.	[optional]
verification_enabled	bool	Indicates whether verification is enabled for this user.	[optional]
verification_required	bool	Indicates whether verification is required. This attribute doesn't apply to administrators.	[optional]

Example