Skip to content

BatchCreateUserRequestItem

Source code in docs_src/capo_wickr/types/batch_create_user_request_item.py
class BatchCreateUserRequestItem(TypedDict, closed=True):
    first_name: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>The first name of the user.</p>"""
    last_name: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>The last name of the user.</p>"""
    security_group_ids: "capo_wickr.types.security_group_id_list.SecurityGroupIdList"
    """<p>A list of security group IDs to which the user should be assigned.</p>"""
    username: "capo_wickr.types.generic_string.GenericString"
    """<p>The email address or username for the user. Must be unique within the network.</p>"""
    invite_code: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>A custom invite code for the user. If not provided, one will be generated automatically.</p>"""
    invite_code_ttl: NotRequired["int"]
    """<p>The time-to-live for the invite code in days. After this period, the invite code will expire.</p>"""
    code_validation: NotRequired["bool"]
    """<p>Indicates whether the user can be verified through a custom invite code.</p>"""

code_validation instance-attribute

code_validation: NotRequired[bool]

Indicates whether the user can be verified through a custom invite code.

first_name instance-attribute

first_name: NotRequired[SensitiveString]

The first name of the user.

invite_code instance-attribute

invite_code: NotRequired[GenericString]

A custom invite code for the user. If not provided, one will be generated automatically.

invite_code_ttl instance-attribute

invite_code_ttl: NotRequired[int]

The time-to-live for the invite code in days. After this period, the invite code will expire.

last_name instance-attribute

last_name: NotRequired[SensitiveString]

The last name of the user.

security_group_ids instance-attribute

security_group_ids: SecurityGroupIdList

A list of security group IDs to which the user should be assigned.

username instance-attribute

username: GenericString

The email address or username for the user. Must be unique within the network.