Get Family Settings | API Reference | Descope Documentation

GET

/v1/mgmt/family/settings

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Get the project's family account settings, using a valid management key.

curl -X GET "https://api.descope.com/v1/mgmt/family/settings"

curl -X GET "https://api.descope.com/v1/mgmt/family/settings"

ResponseOK

{
  "enabled": true,
  "maxFamilyMembers": 0,
  "allowMultipleFamiliesUsers": true
}

{  "enabled": true,  "maxFamilyMembers": 0,  "allowMultipleFamiliesUsers": true}

TypeScript

export interface Response {
enabled?: boolean
maxFamilyMembers?: number
allowMultipleFamiliesUsers?: boolean
}

export interface Response {enabled?: booleanmaxFamilyMembers?: numberallowMultipleFamiliesUsers?: boolean}

Was this helpful?