UserParms

Attributes for the new user.

Properties

Name	Type	Description	Notes
apply_grace_period	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	str	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]
email_verification	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]
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. To unset the external ID, specify an empty string.	[optional]
external_source	str	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]
first_name	str	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[str]	A list of group UUIDs to be assigned to this user. If specified, these groups replace existing groups.	[optional]
last_name	str	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	str	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	str	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]
oauth_roles	List[str]	A list of oauth role UUIDs to be assigned to this user. If specified, these oauth roles replace existing oauth roles.	[optional]
organizations	List[str]	A list of organization UUIDs to be assigned to this user. If specified, these organizations replace existing organizations.	[optional]
phone	str	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]
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_required	bool	Indicates whether self-registration is required. If not set when the user is created, this value defaults to true.	[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]
state	str	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]
user_aliases	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]
user_attribute_values	List[UserAttributeValue]	A list of user attribute values for this user.	[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. 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]
user_principal_name	str	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]
verification_required	bool	Indicates whether verification is required. If not set when the user is created, this value defaults to true.	[optional]

Example