ParticipantToken
Object specifying a participant token in a stage.
Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.
Contents
- attributes
-
Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Type: String to string map
Required: No
- capabilities
-
Set of capabilities that the user is allowed to perform in the stage.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Valid Values:
PUBLISH | SUBSCRIBERequired: No
- duration
-
Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20160.
Required: No
- expirationTime
-
ISO 8601 timestamp (returned as a string) for when this token expires.
Type: Timestamp
Required: No
- participantId
-
Unique identifier for this participant token, assigned by IVS.
Type: String
Required: No
- token
-
The issued client token, encrypted.
Type: String
Required: No
- userId
-
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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
