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
AlternateEmails	List<UserAlternateEmails>	A list of all the users alternate emails.	[optional]
AuthenticatorLockoutStatus	List<UserAuthenticatorLockoutStatus>	A list of all authenticators that the user has with their lockout status.	[optional]
DirectoryDN	string	The DN of the user in the directory the user was synchronized from.	[optional]
DirectoryId	string	If the user was synchronized from a directory, the UUID of that directory.	[optional]
DirectoryName	string	If the user was synchronized from a directory, the name of that directory.	[optional]
DirectoryObjectGUID	string	The objectGUID of the user in the directory the user was synchronized from.	[optional]
DirectoryType	string	The type of the directory user was synchronized from.	[optional]
Email	string	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]
ExternalId	string	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]
ExternalSource	string	An optional value that describes the source when the user is synchronized from an external source.	[optional]
FidoTokens	List<FIDOToken>	A list of all the FIDO tokens owned by this user.	[optional]
FirstName	string	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]
FrozenGracePeriod	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	string	The unique UUID for this user. This value is generated by the service when a user is created.	[optional]
LastAuthTime	DateTime?	The last time this user successfully authenticated. Null if the user has never authenticated.	[optional]
LastModified	DateTime?	When the user was last modified.	[optional]
LastName	string	The last name of this user. This value may or may not be required depending on configuration.	[optional]
Locale	string	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]
LockedAuthenticatorTypes	List<User.LockedAuthenticatorTypesEnum>	The user authenticators that are locked.	[optional]
LockedAuthenticators	List<User.LockedAuthenticatorsEnum>	The user authenticators that are locked. Deprecated: use lockedAuthenticatorTypes	[optional]
LockoutExpiry	DateTime?	If the user is locked, this value will specify the time at which the lockout will expire.	[optional]
MagicLinkEnabled	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	string	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]
OauthRoles	List<OAuthRole>	A list of all oauth roles to which this user belongs.	[optional]
Organizations	List<Organization>	A list of the user organizations.	[optional]
OtpCreateTime	DateTime?	If the user has an OTP, this attribute specifies when the user's OTP was created.	[optional]
PasswordExpirationTime	DateTime?	The password expiration time.	[optional]
Phone	string	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]
PreferredOtpDelivery	string	Preferred OTP delivery type (SMS, EMAIL or VOICE) or SYSTEM to use the system defined default.	[optional]
PreferredOtpDeliveryContactAttributes	Dictionary<string, string>	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]
RegistrationEnabled	bool?	Indicates whether registration is enabled for this user.	[optional]
RegistrationRequired	bool?	Indicates whether self-registration is required. This attribute doesn't apply to administrators.	[optional]
SecurityId	string	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]
ShowNotification	bool?	Indicates whether to show notifications to this user.	[optional]
SmartCredentials	List<SmartCredential>	A list of all the smart credentials owned by this user.	[optional]
State	string	The state of this user. Only users in the ACTIVE state can perform authentication.	[optional]
TempAccessCode	TempAccessCode		[optional]
Tokens	List<Token>	A list of all the tokens owned by this user.	[optional]
Type	string	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]
UserAliases	List<UserAlias>	A list of user aliases for this user.	[optional]
UserAttributeValues	List<UserAttributeValue>	A list of user attribute values for this user.	[optional]
UserCreationTime	DateTime?	The time this user was created.	[optional]
UserExtraAttributes	List<UserExtraAttribute>	A list of extra optional attributes for this user.	[optional]
UserId	string	The user ID for this user.	[optional]
UserPrincipalName	string	The user principal name of this user. This value may or may not be required depending on configuration.	[optional]
VerificationEnabled	bool?	Indicates whether verification is enabled for this user.	[optional]
VerificationRequired	bool?	Indicates whether verification is required. This attribute doesn't apply to administrators.	[optional]