Authorize

Zoom Video SDKs use JSON Web Tokens (JWT) for authorization to start and join sessions. Generate a Video SDK JWT using your Video SDK app credentials.

Only your Video SDK account can start and join your sessions. Other Video SDK accounts cannot join your sessions, and the Video SDK cannot join Zoom Meetings or Webinars.

<JWTGenerator appType="video" />
Use the [Video SDK auth endpoint sample](https://github.com/zoom/videosdk-auth-endpoint-sample) to generate a Video SDK JWT securely, then start or join sessions for [your chosen platform](#pick-a-platform-and-get-started).

How to generate a Video SDK JWT

First, get your Video SDK key and secret. Use these credentials to generate your Video SDK JWT on a secure server-side environment.

A JWT consists of three parts: Header, Payload, and Signature.

Header

The header specifies the signing algorithm and the token type.

Sample header

{
  "alg": "HS256",
  "typ": "JWT"
}

Payload

The payload contains the token claims, user information, and required metadata.

Sample payload

{
  "app_key": ZOOM_VIDEO_SDK_KEY,
  "role_type": ROLE,
  "tpc": SESSION_NAME,
  "version": 1,
  "iat": 1646937553,
  "exp": 1646944753,
  "user_key": USER_KEY
  "session_key": SESSION_KEY,
  "geo_regions": "US,AU,CA,IN,CN,BR,MX,HK,SG,JP,DE,NL",
  "cloud_recording_option": 0,
  "cloud_recording_election": 0,
  "telemetry_tracking_id": "",
  "video_webrtc_mode": 0,
  "audio_webrtc_mode": 1,
  "cloud_recording_transcript_option": 0
}

Signature

The signature is generated by signing the header and payload using your Video SDK secret and the HMAC SHA256 algorithm.

Sample signature

HMACSHA256(
    base64UrlEncode(header) + "." + base64UrlEncode(payload),
    ZOOM_VIDEO_SDK_SECRET,
);

Sample Video SDK JWT

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Sample code (Node.js)

The Node.js sample code below shows how to generate a Video SDK JWT using jsrsasign, an open source cryptographic JavaScript library. For additional JWT libraries and code samples in more languages, see JWT.io.

Commented out properties are optional for all platforms.

import { KJUR } from "jsrsasign";
const iat = Math.floor(Date.now() / 1000) - 30;
const exp = iat + 60 * 60 * 2;
const payload = {
    app_key: process.env.ZOOM_SDK_KEY,
    tpc: "My Session",
    role_type: 0,
    version: 1,
    iat: iat,
    exp: exp,
    // session_key: "my-session",
    // user_key: "user-123",
    // geo_regions: "",
    // cloud_recording_option: 0,
    // cloud_recording_election: 0,
    // telemetry_tracking_id: "",
    // video_webrtc_mode: 0,
    // audio_webrtc_mode: 1
};
const token = KJUR.jws.JWS.sign(
    "HS256",
    JSON.stringify({ alg: "HS256", typ: "JWT" }),
    JSON.stringify(payload),
    process.env.ZOOM_SDK_SECRET,
);
console.log(token);

Start and join sessions with the Video SDK JWT

Use the generated JWT to start or join a Video SDK session.

Session passwords may be up to 10 characters and must consist of visible alphanumeric and standard keyboard special characters (ch >= 32 && ch < 127).

val params = ZoomVideoSDKSessionContext()
params.sessionName = "My session name"
params.userName = "My Name"
params.sessionPassword = "My session passcode"
params.token = "" // Your Video SDK JWT
val session = ZoomVideoSDK.getInstance().joinSession(params)

let sessionContext = ZoomVideoSDKSessionContext()
sessionContext.sessionName = "My session name"
sessionContext.userName = "My name"
sessionContext.sessionPassword = "My session passcode"
sessionContext.token = "" // Your Video SDK JWT
ZoomVideoSDK.shareInstance()?.joinSession(sessionContext)

let sessionContext = ZMVideoSDKSessionContext()
sessionContext.sessionName = "My session name"
sessionContext.userName = "My name"
sessionContext.sessionPassword = "My session passcode"
sessionContext.token = "" // Your Video SDK JWT
ZMVideoSDK.shared()?.joinSession(sessionContext)

await zoom.joinSession({
    sessionName: "My session name",
    userName: "My name",
    sessionPassword: "My session passcode",
    token: "", // Your Video SDK JWT
    audioOptions: { connect: true, mute: false },
    videoOptions: { localVideoOn: true },
});

client
    .join(topic, token, userName, password)
    .then(() => {
        const stream = client.getMediaStream();
    })
    .catch(console.error);

ZoomVideoSDKSessionContext sessionContext;
sessionContext.sessionName = L"My session name";
sessionContext.userName = L"My name";
sessionContext.sessionPassword = L"My session passcode";
sessionContext.token = L""; // Your Video SDK JWT
IZoomVideoSDKSession* pSession = m_pVideoSDK->joinSession(sessionContext);

See the platform-specific Video SDK documentation for more details.

Troubleshooting

If you have issues generating or using your SDK JWT, ensure that:

1. Your account is licensed for the Video SDK.
2. You're using the correct app credentials.
3. The JWT is signed with your Video SDK secret.
4. The tpc value matches the session name in the join context and is under 200 characters.
5. exp is ≤ 48 hours after iat.
6. exp is ≥ 1800 seconds after iat.