Skip navigation

Skip to main content

API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload Changelog

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement

addPage createRichtextRange editContent getCurrentPageContext getDefaultPageDimensions

getDesignMetadata getDesignToken initAppElement openDesign overlay.registerOnCanOpen requestExport selection.registerOnChange setCurrentPageBackground ui.startDragToCursor ui.startDragToPoint ui.startDrag

Error

Intents

Intents: Content

prepareContentPublisher

Intents: data

prepareDataConnector

Intents: design

prepareDesignEditor

Platform

appProcess appProcess.broadcastMessage appProcess.current appProcess.current.getInfo appProcess.current.requestClose appProcess.current.setOnDispose appProcess.requestClose appProcess.registerOnMessage appProcess.registerOnStateChange features.isSupported features.registerOnSupportChange getPlatformInfo notification.addToast requestOpenExternalUrl Changelog

User

auth.getCanvaUserToken auth.initOauth Changelog

auth.getCanvaUserToken

API reference for the auth.getCanvaUserToken method.

Returns a JSON Web Token (JWT) that contains information about the current user.

This token must be decoded and verified via the app's backend.

The verified token is an object with the following properties:

aud - The ID of the app.
brandId - The ID of the user's team.
userId - The ID of the user.

To learn how to decode and verify JWTs, see JSON Web Tokens.

Usage: Get a JWT that contains information about the current user

import { auth } from '@canva/user';

const token = await auth.getCanvaUserToken();

TYPESCRIPT

Returns

A JSON Web Token (JWT) that contains information about the current user.

Promise<CanvaUserToken>

Rate limit

This method has a rate limit of 10 requests every 10 seconds.