Actor Tokens

Create actor token

Changed on

Create an actor token that can be used to impersonate the given user. The actor parameter needs to include at least a "sub" key whose value is the ID of the actor (impersonating) user.

post/actor_tokens

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/actor_tokens
  • Auth: HTTP bearer

Request body

user_idstring required

The ID of the user being impersonated.

expires_in_secondsinteger

Optional parameter to specify the life duration of the actor token in seconds. By default, the duration is 1 hour.

session_max_duration_in_secondsinteger

The maximum duration that the session which will be created by the generated actor token should last. By default, the duration of a session created via an actor token, lasts 30 minutes.

Example request

{
  "actor": {
    "sub": "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"
  }
}

Response

Success

object'actor_token' required
idstring required
status'pending' | 'accepted' | 'revoked' required
user_idstring required
actorobject required
tokenstring
urlstring
created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

Changes