Get tenant plugin schema.

GET

/api/admin/plugins/{id}/schema

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/plugins/example/schema \
  --header 'Authorization: Bearer <token>'

Return the plugin JSON schema used by the Admin UI to render configuration controls.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Plugin identifier.

Responses

200

Plugin schema response.

Media type application/json

object

pluginId

required

string

version

required

string

schema

required

object

key

additional properties

meta

required

object

key

additional properties

key

additional properties

Example ^generated

{
  "pluginId": "example",
  "version": "example",
  "schema": {
    "additionalProperty": "example"
  },
  "meta": {
    "additionalProperty": "example"
  }
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}