Sign in

v1

latestOpenAPI 3.0.2Terms of Use2026-08-061441681.6 MB
advanced_token_authentication

Create a playback token

This operation creates a playback token for use with advanced token authentication.

You'll use the PATCH /videos/{id} endpoint to select ADVANCED_TOKEN authentication for your video after you have the playback token. Then, you'll add the token into your player site along with the JS-embed for the video.

Before using the ADVANCED_TOKEN option as your token authentication for a video, you must do the following:

  • Generate a playback token key that has a key id using the POST /playback_tokens/key in the Wowza Video API, then customize and generate a token via this endpoint in the Wowza Video 2.0 API to add to your site. You'll need the key id to create and sign the token.
post/playback_tokens

Request body

key_idstring required

The unique identifier for the id key returned when you used the POST /playback_tokens/keys endpoint to create a playback token key. This key will sign the token you create.

expinteger required

The expiration time of the token which is the <a href="https://www.unixtimestamp.com/" target="_blank">unix timestamp</a> in seconds. If the current time is greater than the expiration time, the request will be considered invalid.

nbfinteger

The time before which the token must not be accepted for processing which is the <a href="https://www.unixtimestamp.com/" target="_blank">unix timestamp</a> in seconds.

iatinteger

The issue date of the token which is the <a href="https://www.unixtimestamp.com/" target="_blank">unix timestamp</a> in seconds.

issstring

The issuer of the token.

substring

The subject of the token.

audstring

The audience of the token.

ctistring

Uniquely identifies a token to help prevent reuse or replay attacks.

catuobject

A map of URIs to which the token applies. The maximum number of items allowed is five. The object contains an array of key and value.

catgeoiso3166string[]

The ISO3166 country codes from which the token was issued. Optionally, followed by a hyphen and a region code. the maximum number allowed is five.

catvinteger

The version of the token. The integer must be 1.

Example request

{
  "key_id": "51cd5c07-1583-4f5e-bd81-f1aa11510ea9",
  "exp": 1679816499,
  "nbf": 1679816499,
  "iat": 1679816499,
  "iss": "my-issuer",
  "sub": "subscriber1234",
  "aud": "my-audience",
  "cti": "unique-token-id",
  "catnip": [
    {
      "tag": 52,
      "value": [
        24,
        {
          "0": "188k",
          "1": 4,
          "2": 23
        }
      ]
    }
  ],
  "catgeoiso3166": [
    "US",
    "CA-ON"
  ],
  "catv": 1
}

Response

Success

tokenstring

The unique identifier for the playback token.

Add this token to your site along with the JS-embed for the video to use advanced token authentication. You must also use PATCH /videos/{id} to select ADVANCED_TOKEN as your authentication type for the video after you create the playback token.