Impersonation

Impersonation Documentation

Impersonation [POST]

This endpoint allows an admin to impersonate any user by receiving a jwt that can be used to access any resources on the API on behalf of the impersonated user.

Request

Endpoint

POST /api/v2/admin/impersonation
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "impersonation",
    "attributes": {
      "reason": "Reason",
      "user": "aabeca64-f006-4595-8bfc-e668c081a447"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

reason

Type string

Description The reason for the impersonation

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

user

Type string

Description The User Name, ID or Key/Relay Email of the user to impersonate

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "aabeca64-f006-4595-8bfc-e668c081a447",
    "type": "impersonation",
    "attributes": {
      "created_at": "2022-01-12T17:18:28Z",
      "json_web_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiYWFiZWNhNjQtZjAwNi00NTk1LThiZmMtZTY2OGMwODFhNDQ3IiwiZXhwIjoxNjQyMDExNTA4fQ.ThudMynfhFSBo2rYM0CZMiaA64crgU0CFxNfYiUtXZ0",
      "updated_at": null,
      "updated_in_db_at": null
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

json_web_token

Type string

Description The JWT for the user being impersonated

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.