Skip to content

ExchangedParticipantToken

Source code in docs_src/capo_ivs_realtime/types/exchanged_participant_token.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class ExchangedParticipantToken(TypedDict, closed=True):
    capabilities: NotRequired[
        "capo_ivs_realtime.types.participant_token_capabilities.ParticipantTokenCapabilities"
    ]
    """<p>Set of capabilities that the user is allowed to perform in the stage.</p>"""
    attributes: NotRequired[
        "capo_ivs_realtime.types.participant_token_attributes.ParticipantTokenAttributes"
    ]
    """<p>Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>"""
    user_id: NotRequired[
        "capo_ivs_realtime.types.participant_token_user_id.ParticipantTokenUserId"
    ]
    """<p>Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>"""
    expiration_time: NotRequired[
        "capo_ivs_realtime.types.participant_token_expiration_time.ParticipantTokenExpirationTime"
    ]
    """<p>ISO 8601 timestamp (returned as a string) for when this token expires.</p>"""

attributes instance-attribute 

attributes: NotRequired[ParticipantTokenAttributes]

Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

capabilities instance-attribute 

capabilities: NotRequired[ParticipantTokenCapabilities]

Set of capabilities that the user is allowed to perform in the stage.

expiration_time instance-attribute 

expiration_time: NotRequired[ParticipantTokenExpirationTime]

ISO 8601 timestamp (returned as a string) for when this token expires.

user_id instance-attribute 

user_id: NotRequired[ParticipantTokenUserId]

Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.