Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1439243197.0 KB

Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.

Encryption keys are owned by Amazon IVS and never used directly by your application.

post/CreateParticipantToken

Request body

stageArnstring required

ARN of the stage to which this token is scoped.

durationinteger

Duration (in minutes), after which the token expires. Default: 720 (12 hours).

userIdstring

Name that can be specified to help identify the token. 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>

attributesobject

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>

capabilitiesParticipantTokenCapability[]

Set of capabilities that the user is allowed to perform in the stage. Default: <code>PUBLISH, SUBSCRIBE</code>.

Response

Success