UserParms

Attributes for the new user.

Properties

Name	Type	Description	Notes
ApplyGracePeriod	bool?	Indicates if the user is granted a new frozen grace period. This value is not used when creating a user. If provided, it will be ignored.	[optional]
Email	string	The email address of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. It must be set to use EMAIL OTP authentication and other features that require an email address. To remove the existing value, set the value to an empty string.	[optional]
EmailVerification	bool?	Indicates if a verification email message should be sent to the user if the user now requires verification. The user's policy requiring user verification must also be enabled for the user. If not set, this value defaults to true.	[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. To unset the external ID, specify an empty string.	[optional]
ExternalSource	string	An optional value that describes the source when the user is synchronized from an external source. To unset the external source, specify an empty string.	[optional]
FirstName	string	The first name of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. To remove the existing value, set the value to an empty string.	[optional]
Groups	List<string>	A list of group UUIDs to be assigned to this user. If specified, these groups replace existing groups.	[optional]
LastName	string	The last name of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. To remove the existing value, set the value to an empty string.	[optional]
Locale	string	The locale of this user. If not set, the default account locale will be used. To remove the existing value, set the value to an empty string.	[optional]
Lock	bool?	Indicates if all the user's authenticators are locked or not.	[optional]
Mobile	string	The mobile number of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. It must be set to use SMS OTP authentication. To remove the existing value, set the value to an empty string.	[optional]
OauthRoles	List<string>	A list of oauth role UUIDs to be assigned to this user. If specified, these oauth roles replace existing oauth roles.	[optional]
Organizations	List<string>	A list of organization UUIDs to be assigned to this user. If specified, these organizations replace existing organizations.	[optional]
Phone	string	The phone number of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. It must be set to use VOICE OTP authentication. To remove the existing value, set the value to an empty string.	[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]
RegistrationRequired	bool?	Indicates whether self-registration is required. If not set when the user is created, this value defaults to true.	[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]
State	string	The state of this user. Only users in the ACTIVE state can perform authentication. If not set when the user is created, this value defaults to ACTIVE.	[optional]
UserAliases	List<UserAlias>	A list of user aliases for this user. Alias values must be unique with respect to the userId and other aliases of this user and other users.	[optional]
UserAttributeValues	List<UserAttributeValue>	A list of user attribute values for this user.	[optional]
UserExtraAttributes	List<UserExtraAttribute>	A list of extra optional attributes for this user.	[optional]
UserId	string	The user ID for this user. This value is required when creating the user, optional during update. The userId must be unique with respect to aliases of this user and the userId and aliases of all other users.	[optional]
UserPrincipalName	string	The user principal name of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. To remove the existing value, set the value to an empty string.	[optional]
VerificationRequired	bool?	Indicates whether verification is required. If not set when the user is created, this value defaults to true.	[optional]