Skip to content

Photo

Source code in docs_src/capo_identitystore/types/photo.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class Photo(TypedDict, closed=True):
    value: "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    """<p>The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.</p>"""
    type: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The type of photo. This field is optional and can be used to categorize different types of photos.</p>"""
    display: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A human-readable description of the photo for display purposes. This optional field provides context about the photo.</p>"""
    primary: "capo_identitystore.types.boolean_type.BooleanType"
    """<p>Specifies whether this is the user's primary photo. Default value is <code>false</code>. Only one photo can be designated as primary per user.</p>"""

display instance-attribute 

display: NotRequired[SensitiveStringType]

A human-readable description of the photo for display purposes. This optional field provides context about the photo.

primary instance-attribute 

primary: BooleanType

Specifies whether this is the user's primary photo. Default value is false. Only one photo can be designated as primary per user.

type instance-attribute 

type: NotRequired[SensitiveStringType]

The type of photo. This field is optional and can be used to categorize different types of photos.

value instance-attribute 

value: SensitiveStringType

The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.