AuthZEN Subject Search | API Reference

POST

/v1/mgmt/fga/authzen/access/v1/search/subject

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

subject?object

Required (spec §8.4.1): MUST carry a type (echoed onto each result); the id is omitted/ignored.

action?object

resource?object

context?object

Return the subjects permitted to perform the given action on the given resource (OpenID AuthZEN Subject Search API).

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

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

ResponseOK

{
  "results": [
    {
      "type": "string",
      "id": "string"
    }
  ]
}

{  "results": [    {      "type": "string",      "id": "string"    }  ]}

TypeScript

export interface Response {
results?: {
type?: string
/**
 * optional: the searched entity in Subject Search omits its id (spec §8), so id is not required.
 */
id?: string
}[]
}

export interface Response {results?: {type?: string/** * optional: the searched entity in Subject Search omits its id (spec §8), so id is not required. */id?: string}[]}

Was this helpful?