BizKitHub
DocsAPI ReferenceImpersonate/bff/impersonate/status
getImpersonateAdmin BFF

/bff/impersonate/status

Cheap identity-derived check used by the admin header to decide whether to show the impersonate button (via canImpersonate) and whether to render the "viewing as X" banner (via isImpersonating).

ImpersonategetBffImpersonateStatus

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
object | object
One of 2:
Variant 1
isImpersonating"false"Required
canImpersonatebooleanRequired

True when the caller effectively holds root or admin-impersonate.

selfContactExternalIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
Variant 2
isImpersonating"true"Required
canImpersonate"true"Required
selfContactExternalIdstringRequired
effectiveobjectRequired
contactExternalIdstringRequired
fullNamestringRequired
emailstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
realobjectRequired
contactExternalIdstringRequired
fullNamestringRequired
emailstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
startedAtstringRequired
expiresAtstringRequired

Response example

application/json
{
  "isImpersonating": false,
  "canImpersonate": false
}

Request example

GET /bff/impersonate/status

get
curl -X GET "https://api.bizkithub.com/bff/impersonate/status" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key