Search Families | API Reference | Descope Documentation

POST

/v1/mgmt/family/search

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

familyIds?array<string>

string

freeText?string

familyNames?array<string>

string

page?integer

Formatint32

size?integer

Formatint32

customAttributes?object

Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays.

Example

{
  "attribute-key": "attribute-value"
}

Search families, using a valid management key.

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

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

ResponseOK

{
  "families": [
    {
      "id": "string",
      "name": "string",
      "customAttributes": {
        "attribute-key": "attribute-value"
      },
      "disabled": true,
      "photo": "string",
      "createdTime": 0
    }
  ]
}

{  "families": [    {      "id": "string",      "name": "string",      "customAttributes": {        "attribute-key": "attribute-value"      },      "disabled": true,      "photo": "string",      "createdTime": 0    }  ]}

TypeScript

export interface Response {
families?: {
id?: string
name?: string
/**
 * Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays.
 */
customAttributes?: {
[k: string]: string
}
disabled?: boolean
photo?: string
createdTime?: number
}[]
}

export interface Response {families?: {id?: stringname?: string/** * Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. */customAttributes?: {[k: string]: string}disabled?: booleanphoto?: stringcreatedTime?: number}[]}

Was this helpful?