Impersonate Family Dependent | API Reference

POST

/v1/mgmt/family/impersonate

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

impersonatorUserIdOrLoginId?string

the impersonator (acting family admin), by user ID or login ID; must be a member of the dependent's family and hold the family impersonate-dependents permission there

dependentLoginId?string

the target dependent, by login ID

selectedFamily?string

optional family to scope the impersonated session to (stamped as the current-family claim); when set it must be the dependent's family. Omitted -> the impersonated session carries no current-family claim

Impersonate a family dependent. The impersonator (by user ID) must be a member of the dependent's family and hold the family impersonate-dependents permission there.

curl -X POST "https://api.descope.com/v1/mgmt/family/impersonate" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://api.descope.com/v1/mgmt/family/impersonate" \  -H "Content-Type: application/json" \  -d '{}'

ResponseOK

{
  "jwt": "string"
}

{  "jwt": "string"}

TypeScript

export interface Response {
jwt?: string
}

export interface Response {jwt?: string}

Was this helpful?