Apis::V4::Impersonations API

Impersonate a user

Parameters

Name Description
access_token JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
id The user_id that you want to impersonate

Response Fields

Name Description
token MH JSON Web Token that will contain a user_id, a super_admin_id, and an expires at
first_name Impersonated User's first name
last_name Impersonated User's last name
person_id Impersonated User's person id
profile_image_url Impersonated User's profile image
thekey_uid Impersonated User's UID for TheKey.me

Request

Headers

Version: HTTP/1.0
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo0MiwiZXhwIjoxNzA0NDczMjI0LCJpYXQiOjE3MDQ0NzMwNDR9.H_6anfBI0nj7dFpxigOEtuF4MoLz4eJ3grkDCkhF03k
Host: example.org
Cookie: 

Route

GET /apis/v4/impersonations/43

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
Vary: Accept
X-MH-Session: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo0Mywic3VwZXJfYWRtaW5faWQiOjQyLCJleHAiOjE3MDQ0NzQ4NDQsImlhdCI6MTcwNDQ3MzA0NH0.LuSh5Cl_c9v_S6CxJvNVFJYIPveyRvDmAdqOGHQPcSI
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"da6d1887d2c8e7b844b55aabfe0beda9"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: dac65784-6d73-4705-8be8-6cf67c0c064a
X-Runtime: 0.019043
Content-Length: 322

Status

200

Body