Skip to content

UserIdentityInfo

Used by
Source code in docs_src/capo_connect/types/user_identity_info.py 
14
15
16
17
18
19
20
21
22
23
24
class UserIdentityInfo(TypedDict, closed=True):
    first_name: NotRequired["capo_connect.types.agent_first_name.AgentFirstName"]
    """<p>The first name. This is required if you are using Connect Customer or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.</p>"""
    last_name: NotRequired["capo_connect.types.agent_last_name.AgentLastName"]
    """<p>The last name. This is required if you are using Connect Customer or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.</p>"""
    email: NotRequired["capo_connect.types.email.Email"]
    """<p>The email address. If you are using SAML for identity management and include this parameter, an error is returned.</p>"""
    secondary_email: NotRequired["capo_connect.types.email.Email"]
    r"""<p>The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.</p> <p>Pattern: <code>(?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}</code> </p>"""
    mobile: NotRequired["capo_connect.types.phone_number.PhoneNumber"]
    """<p>The user's mobile number.</p>"""

email instance-attribute 

email: NotRequired[Email]

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

first_name instance-attribute 

first_name: NotRequired[AgentFirstName]

The first name. This is required if you are using Connect Customer or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

last_name instance-attribute 

last_name: NotRequired[AgentLastName]

The last name. This is required if you are using Connect Customer or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

mobile instance-attribute 

mobile: NotRequired[PhoneNumber]

The user's mobile number.

secondary_email instance-attribute 

secondary_email: NotRequired[Email]

The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}