Skip to content

DescribeUserRequest

Source code in docs_src/capo_workmail/types/describe_user_request.py 
14
15
16
17
18
class DescribeUserRequest(TypedDict, closed=True):
    organization_id: "capo_workmail.types.organization_id.OrganizationId"
    """<p>The identifier for the organization under which the user exists.</p>"""
    user_id: "capo_workmail.types.entity_identifier.EntityIdentifier"
    """<p>The identifier for the user to be described.</p> <p>The identifier can be the <i>UserId</i>, <i>Username</i>, or <i>email</i>. The following identity formats are available:</p> <ul> <li> <p>User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p> </li> <li> <p>Email address: [email protected]</p> </li> <li> <p>User name: user</p> </li> </ul> <p></p>"""

organization_id instance-attribute 

organization_id: OrganizationId

The identifier for the organization under which the user exists.

user_id instance-attribute 

user_id: EntityIdentifier

The identifier for the user to be described.

The identifier can be the UserId, Username, or email. The following identity formats are available:

  • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: [email protected]

  • User name: user