impersonateUser

POST

/admin/impersonate-user

Impersonate a user

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Impersonation session created

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠429Too Many Requests

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/admin/impersonate-user' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userId": "string"
}'

Response Example

200 - Example 1

{
    "session": {
        "id": "string",
        "expires_at": "string",
        "token": "string",
        "created_at": "string",
        "updated_at": "string",
        "ip_address": "string",
        "user_agent": "string",
        "user_id": "string",
        "impersonated_by": "string",
        "active_organization_id": "string"
    },
    "user": {
        "id": "string",
        "name": "string",
        "email": "string",
        "email_verified": true,
        "image": "string",
        "created_at": "string",
        "updated_at": "string",
        "phone_number": "string",
        "phone_number_verified": true,
        "role": "string",
        "banned": true,
        "ban_reason": "string",
        "ban_expires": "string",
        "balance": "100"
    }
}

Modified at 2025-11-11 19:04:55

banUser

/admin/stop-impersonating