User Class

Active Directory user information.

Variables are only populated by the server, and will be ignored when sending a request.

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

Inheritance

DirectoryObject

User

Constructor

User(**kwargs)

Parameters

additional_properties

dict[str, object]

Required

Unmatched properties from the message are deserialized this collection

object_type

str

Required

Required. Constant filled by server.

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

Whether the account is enabled.

display_name

str

Required

The display name of the user.

user_principal_name

str

Required

The principal name of the user.

mail_nickname

str

Required

The mail alias for the user.

mail

str

Required

The primary email address of the user.

sign_in_names

list[SignInName]

Required

The sign-in names of the user.

Variables

object_id

str

The object ID.

deletion_timestamp

datetime

The time at which the directory object was deleted.