Skip to content

Name

Used by
Source code in docs_src/capo_identitystore/types/name.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class Name(TypedDict, closed=True):
    formatted: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string containing a formatted version of the name for display.</p>"""
    family_name: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The family name of the user.</p>"""
    given_name: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The given name of the user.</p>"""
    middle_name: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The middle name of the user.</p>"""
    honorific_prefix: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The honorific prefix of the user. For example, "Dr."</p>"""
    honorific_suffix: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The honorific suffix of the user. For example, "M.D."</p>"""

family_name instance-attribute 

family_name: NotRequired[SensitiveStringType]

The family name of the user.

formatted instance-attribute 

formatted: NotRequired[SensitiveStringType]

A string containing a formatted version of the name for display.

given_name instance-attribute 

given_name: NotRequired[SensitiveStringType]

The given name of the user.

honorific_prefix instance-attribute 

honorific_prefix: NotRequired[SensitiveStringType]

The honorific prefix of the user. For example, "Dr."

honorific_suffix instance-attribute 

honorific_suffix: NotRequired[SensitiveStringType]

The honorific suffix of the user. For example, "M.D."

middle_name instance-attribute 

middle_name: NotRequired[SensitiveStringType]

The middle name of the user.