Skip to main content
POST
/
admin
/
impersonate
/
{userId}
Start an impersonation session
curl --request POST \
  --url https://api.royalti.io/admin/impersonate/{userId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/admin/impersonate/{userId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/admin/impersonate/{userId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/admin/impersonate/{userId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/admin/impersonate/{userId}"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.royalti.io/admin/impersonate/{userId}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/admin/impersonate/{userId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "<string>",
  "data": {
    "token": "<string>",
    "expiresIn": 1800,
    "user": {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "role": "<string>"
    }
  }
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

​
Description

TenantUser. The target identifier may be either a TenantUser.id (preferred — supports roster-only rows without a linked User) or a User.id (UUID); both are resolved automatically. Denial reasons logged to AuditLogs.metadata.denialReason: caller_not_admin, self_impersonation, target_not_found, no_shared_workspace, target_is_admin.

​
Code Examples

const response = await fetch('https://api.royalti.io/admin/impersonate/example-id', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
  'https://api.royalti.io/admin/impersonate/example-id',
  json={}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/admin/impersonate/example-id \
  -H "Content-Type: application/json" \
  -d '{}'

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

​
userId
string
required

TenantUser.id (preferred) or User.id (UUID) of the target

Response

Impersonation token issued

​
status
enum<string>
Available options:
success
​
message
string
​
data
object