Impersonation
Impersonation Documentation
Impersonation [POST]
This endpoint allows an organization admin to impersonate any user with a related organization account 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/organizations/4ab7e40b-6b30-4a50-9fc8-873c3dca9d37/impersonation
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "impersonation",
"attributes": {
"reason": "Reason",
"user": "7cdb765a-3251-483f-9193-249a5e472fcb"
}
}
}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 OKBody
{
"data": {
"id": "7cdb765a-3251-483f-9193-249a5e472fcb",
"type": "impersonation",
"attributes": {
"created_at": "2021-11-23T14:38:20Z",
"json_web_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiN2NkYjc2NWEtMzI1MS00ODNmLTkxOTMtMjQ5YTVlNDcyZmNiIiwiZXhwIjoxNjM3NjgxOTAwfQ.PVvz39Er-UIMKmKAHjxXLjddV90g7RFpukboopeUbyE",
"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.
Last updated