Skip to Content

POST /profile/emulate

Emulate Profile

Create emulation grant. Next request will resolve to target profile.

Request Body (EmulateProfileApiRequest)

FieldTypeRequiredDescription
target_profile_idstringNoUUID of the profile to emulate (omit on the ack call)
ttl_minutesintegerNoEmulation duration in minutes
idempotency_keystringNoIdempotency / soft-call key. Echo the server-minted value with accept to promote/reject a staged emulation.
softbooleanNoStage the emulation grant dormant (active=False) — it impersonates nothing until accepted
acceptbooleanNoAck: True promotes the staged emulation, False rejects. Only meaningful with idempotency_key

Response (EmulateProfileApiResponse)

FieldTypeRequiredDescription
allowedbooleanYesWhether emulation is allowed
reasonstringNoReason if emulation is denied
grant_idstringNoUUID of the emulation grant
expires_atstringNoWhen the emulation grant expires
idempotency_keystringNoServer-minted soft-call key (audit call_id). On a soft propose, echo this back with accept to promote/reject the staged emulation.
Last updated on