Skip to content

User

Source code in docs_src/capo_directory_service_data/types/user.py
class User(TypedDict, closed=True):
    sid: NotRequired["capo_directory_service_data.types.sid.SID"]
    """<p> The unique security identifier (SID) of the user. </p>"""
    sam_account_name: "capo_directory_service_data.types.user_name.UserName"
    """<p> The name of the user. </p>"""
    distinguished_name: NotRequired[
        "capo_directory_service_data.types.distinguished_name.DistinguishedName"
    ]
    """<p> The <a href="https://learn.microsoft.com/en-us/windows/win32/ad/object-names-and-identities#distinguished-name">distinguished name</a> of the object. </p>"""
    user_principal_name: NotRequired[
        "capo_directory_service_data.types.user_principal_name.UserPrincipalName"
    ]
    """<p> The UPN that is an internet-style login name for a user and based on the internet standard <a href="https://datatracker.ietf.org/doc/html/rfc822">RFC 822</a>. The UPN is shorter than the distinguished name and easier to remember. </p>"""
    email_address: NotRequired[
        "capo_directory_service_data.types.email_address.EmailAddress"
    ]
    """<p> The email address of the user. </p>"""
    given_name: NotRequired["capo_directory_service_data.types.given_name.GivenName"]
    """<p> The first name of the user. </p>"""
    surname: NotRequired["capo_directory_service_data.types.surname.Surname"]
    """<p> The last name of the user. </p>"""
    enabled: NotRequired["bool"]
    """<p> Indicates whether the user account is active. </p>"""
    other_attributes: NotRequired[
        "capo_directory_service_data.types.attributes.Attributes"
    ]
    """<p> An expression that includes one or more attributes, data types, and values of a user.</p>"""

distinguished_name instance-attribute

distinguished_name: NotRequired[DistinguishedName]

The distinguished name of the object.

email_address instance-attribute

email_address: NotRequired[EmailAddress]

The email address of the user.

enabled instance-attribute

enabled: NotRequired[bool]

Indicates whether the user account is active.

given_name instance-attribute

given_name: NotRequired[GivenName]

The first name of the user.

other_attributes instance-attribute

other_attributes: NotRequired[Attributes]

An expression that includes one or more attributes, data types, and values of a user.

sam_account_name instance-attribute

sam_account_name: UserName

The name of the user.

sid instance-attribute

sid: NotRequired[SID]

The unique security identifier (SID) of the user.

surname instance-attribute

surname: NotRequired[Surname]

The last name of the user.

user_principal_name instance-attribute

user_principal_name: NotRequired[UserPrincipalName]

The UPN that is an internet-style login name for a user and based on the internet standard RFC 822. The UPN is shorter than the distinguished name and easier to remember.