Create Participant Token

ivsrealtime_create_participant_token

R Documentation

Creates an additional token for a specified stage¶

Description¶

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.

Usage¶

ivsrealtime_create_participant_token(stageArn, duration, userId,
  attributes, capabilities)

Arguments¶

stageArn: [required] ARN of the stage to which this token is scoped.
duration: Duration (in minutes), after which the token expires. Default: 720 (12 hours).
userId: Name that can be specified to help identify the token. 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.
attributes: 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: Set of capabilities that the user is allowed to perform in the stage. Default: ⁠PUBLISH, SUBSCRIBE⁠.

Value¶

A list with the following syntax:

list(
  participantToken = list(
    participantId = "string",
    token = "string",
    userId = "string",
    attributes = list(
      "string"
    ),
    duration = 123,
    capabilities = list(
      "PUBLISH"|"SUBSCRIBE"
    ),
    expirationTime = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

svc$create_participant_token(
  stageArn = "string",
  duration = 123,
  userId = "string",
  attributes = list(
    "string"
  ),
  capabilities = list(
    "PUBLISH"|"SUBSCRIBE"
  )
)