Create Clerk actor token

Create an impersonation actor token for a user in a connected Clerk application.

← All Clerk endpoints · Capability overview

POST/v1/clerk/actor-tokens

https://api.vee3.io/v1/clerk/actor-tokens

15 tokens

Create an impersonation actor token for a user in a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.create_actor_token

Parameters5 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

user_idstringRequired

Clerk user id (user_...) of the user being impersonated.

actor_substringRequired

Clerk user id (user_...) of the impersonating actor (maps to actor.sub).

expires_in_secondsintegerOptional

Actor token lifetime in seconds (minimum 1). Defaults to 3600 (1 hour).

min 1

session_max_duration_in_secondsintegerOptional

Maximum duration in seconds for the session created from this token (minimum 1). Defaults to 1800 (30 minutes).

min 1

Response10 fields

actor_tokenobject

9 fields

Created Clerk actor token object from the Backend API.

idstring

Actor token id.

user_idstring

Clerk user id (user_...) being impersonated.

statusstring

Token status (pending, accepted, or revoked).

actorobject

1 field

Actor payload; includes sub with the impersonating user id.

substring

Clerk user id (user_...) of the impersonating actor.

tokenstring

Actor token secret. Treat as high-privilege — do not log.

urlstring

Optional sign-in URL that includes the actor token.

created_atinteger

Unix timestamp in milliseconds when the token was created.

updated_atinteger

Unix timestamp in milliseconds when the token was last updated.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/actor-tokens"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123",
    "actor_sub": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created Clerk actor token.

created_actor_token.json

{
  "actor_token": {
    "id": "act_2abc123",
    "user_id": "user_impersonated",
    "status": "pending",
    "actor": {
      "sub": "user_actor"
    },
    "token": "secret_actor_token_value",
    "url": "https://example.com/sign-in?token=secret_actor_token_value",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}