Edit

UserCreateParameters Class

  • Reference

Request parameters for creating a new work or school account user.

All required parameters must be populated in order to send to Azure.

Inheritance
UserBase
UserCreateParameters

Constructor

UserCreateParameters(*, account_enabled: bool, display_name: str, password_profile, user_principal_name: str, mail_nickname: str, additional_properties=None, immutable_id: str = None, usage_location: str = None, given_name: str = None, surname: str = None, user_type=None, mail: str = None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized this collection

immutable_id
str
Required

This must be specified if you are using a federated domain for the user's userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.

usage_location
str
Required

A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: "US", "JP", and "GB".

given_name
str
Required

The given name for the user.

surname
str
Required

The user's surname (family name or last name).

user_type
str or UserType
Required

A string value that can be used to classify user types in your directory, such as 'Member' and 'Guest'. Possible values include: 'Member', 'Guest'

account_enabled
bool
Required

Required. Whether the account is enabled.

display_name
str
Required

Required. The display name of the user.

password_profile
PasswordProfile
Required

Required. Password Profile

user_principal_name
str
Required

Required. The user principal name (<xref:mailto:someuser@contoso.com>). It must contain one of the verified domains for the tenant.

mail_nickname
str
Required

Required. The mail alias for the user.

mail
str
Required

The primary email address of the user.