Get Mappable Schema

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Query Parameters

tenantId?string

resourcesLimit?string

This endpoint allows you to retrieve the mappable schema for Fine-Grained Authorization.

curl -X GET "https://api.descope.com/v1/mgmt/fga/mappable/schema"

curl -X GET "https://api.descope.com/v1/mgmt/fga/mappable/schema"

ResponseOK

{
  "schema": {
    "namespaces": [
      {
        "name": "string",
        "relationDefinitions": [
          {
            "name": "string",
            "complexDefinition": {
              "nType": "string",
              "children": [
                {
                  "nType": "string",
                  "children": [],
                  "expression": {
                    "neType": "string",
                    "relationDefinition": "string",
                    "relationDefinitionNamespace": "string",
                    "targetRelationDefinition": "string",
                    "targetRelationDefinitionNamespace": "string"
                  }
                }
              ],
              "expression": {
                "neType": "string",
                "relationDefinition": "string",
                "relationDefinitionNamespace": "string",
                "targetRelationDefinition": "string",
                "targetRelationDefinitionNamespace": "string"
              }
            }
          }
        ]
      }
    ],
    "name": "string"
  },
  "mappableResources": [
    {
      "type": "string",
      "resources": [
        {
          "resource": "string",
          "displayName": "string"
        }
      ]
    }
  ]
}

{  "schema": {    "namespaces": [      {        "name": "string",        "relationDefinitions": [          {            "name": "string",            "complexDefinition": {              "nType": "string",              "children": [                {                  "nType": "string",                  "children": [],                  "expression": {                    "neType": "string",                    "relationDefinition": "string",                    "relationDefinitionNamespace": "string",                    "targetRelationDefinition": "string",                    "targetRelationDefinitionNamespace": "string"                  }                }              ],              "expression": {                "neType": "string",                "relationDefinition": "string",                "relationDefinitionNamespace": "string",                "targetRelationDefinition": "string",                "targetRelationDefinitionNamespace": "string"              }            }          }        ]      }    ],    "name": "string"  },  "mappableResources": [    {      "type": "string",      "resources": [        {          "resource": "string",          "displayName": "string"        }      ]    }  ]}

TypeScript

export interface Response {
schema?: {
/**
 * List of namespaces in the schema
 */
namespaces?: {
/**
 * Name of the namespace (entity type)
 */
name?: string
/**
 * The relation definitions belonging to the namespace
 */
relationDefinitions?: {
/**
 * Name of the relation definition
 */
name?: string
/**
 * Optional complex definition for complex (union, intersect, sub) relation definitions
 */
complexDefinition?: {
/**
 * Node type can be either child, union, intersect or sub
 */
nType?: string
/**
 * For union, intersect or sub, the children nodes
 */
children?: Node[]
/**
 * The expression for child nodes
 */
expression?: NodeExpression
}
}[]
}[]
name?: string
}
mappableResources?: MappableResources[]
}
export interface Node {
/**
 * Node type can be either child, union, intersect or sub
 */
nType?: string
/**
 * For union, intersect or sub, the children nodes
 */
children?: Node[]
/**
 * The expression for child nodes
 */
expression?: NodeExpression
}
export interface NodeExpression {
/**
 * Expression type can be either self, userSet, relationLeft, relationRight
 */
neType?: string
/**
 * The name of the relation definition for self and relationLeft/Right
 */
relationDefinition?: string
/**
 * The namespace of the relation definition
 */
relationDefinitionNamespace?: string
/**
 * The name of the relation definition for targetSet as well as type of relation for target relationLeft/Right
 */
targetRelationDefinition?: string
/**
 * The namespace of the target relation definition
 */
targetRelationDefinitionNamespace?: string
}
export interface MappableResources {
type?: string
resources?: MappableResource[]
}
export interface MappableResource {
resource?: string
displayName?: string
}

export interface Response {schema?: {/** * List of namespaces in the schema */namespaces?: {/** * Name of the namespace (entity type) */name?: string/** * The relation definitions belonging to the namespace */relationDefinitions?: {/** * Name of the relation definition */name?: string/** * Optional complex definition for complex (union, intersect, sub) relation definitions */complexDefinition?: {/** * Node type can be either child, union, intersect or sub */nType?: string/** * For union, intersect or sub, the children nodes */children?: Node[]/** * The expression for child nodes */expression?: NodeExpression}}[]}[]name?: string}mappableResources?: MappableResources[]}export interface Node {/** * Node type can be either child, union, intersect or sub */nType?: string/** * For union, intersect or sub, the children nodes */children?: Node[]/** * The expression for child nodes */expression?: NodeExpression}export interface NodeExpression {/** * Expression type can be either self, userSet, relationLeft, relationRight */neType?: string/** * The name of the relation definition for self and relationLeft/Right */relationDefinition?: string/** * The namespace of the relation definition */relationDefinitionNamespace?: string/** * The name of the relation definition for targetSet as well as type of relation for target relationLeft/Right */targetRelationDefinition?: string/** * The namespace of the target relation definition */targetRelationDefinitionNamespace?: string}export interface MappableResources {type?: stringresources?: MappableResource[]}export interface MappableResource {resource?: stringdisplayName?: string}

Was this helpful?