POST token/impersonate

Issues a short-lived (24 h) impersonation token for a target customer. Requires a valid staff bearer token; staff must have IsAbleToControlUsers = true.

Request Information

URI Parameters

None.

Body Parameters

ImpersonateRequest
NameDescriptionTypeAdditional information
TargetEmail

string

None.

Request Formats

application/json, text/json

Sample:
{
  "TargetEmail": "sample string 1"
}

Response Information

Resource Description

TokenResponse
NameDescriptionTypeAdditional information
Data

Token object

Token

None.

Code

Response code returned by api

HttpStatusCode

None.

Message

Human readable message

string

None.

TraceId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "AccessToken": "sample string 1",
    "ExpiresIn": "sample string 2"
  },
  "Code": 100,
  "Message": "sample string 1",
  "TraceId": "sample string 2"
}