Get user ID token

webflow.getIdToken()

Retrieves a JSON Web Token (JWT) that uniquely identifies the current user of your Designer Extension. This ID token contains encoded user information that can be used for authentication and authorization purposes.

Authenticating users with the Data API

To decode and verify the token, send a POST request to the Resolve ID Token endpoint. The endpoint will return the user’s details, which you can use to implement permission-based features or personalized experiences in your extension.

Read the guide

Syntax

1
webflow.getIdToken(): Promise<string>;

Returns

Promise<String>

A Promise that resolves to the value of the ID Token. The ID token will remain valid for 15 minutes.

Example

1
// Get ID Token
2
const idToken = await webflow.getIdToken()
3
4
// Print ID Token
5
console.log(idToken)