Set Family Settings | API Reference | Descope Documentation

POST

/v1/mgmt/family/settings

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

application/json

enabled?boolean

maxFamilyMembers?integer

Formatint32

allowMultipleFamiliesUsers?boolean

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

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

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

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?