Get a tenant plugin.

GET

/api/admin/plugins/{id}

Code sample: Shell / cURL

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

Return plugin registry status, masked configuration, schema, and disclaimer information for one plugin.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Plugin identifier.

Responses

200

Plugin detail response.

Media type application/json

object

plugin

required

object

id

string

name

string

version

string

enabled

boolean

configured

boolean

configSource

string | null

missingRequiredFields

Array<string>

key

additional properties

status

required

object

key

additional properties

config

required

object

key

additional properties

configSchema

required

object

key

additional properties

disclaimer

required

string | null

key

additional properties

Example

{
  "plugin": {
    "id": "email.smtp",
    "name": "SMTP Email Provider",
    "version": "1.0.0",
    "enabled": true,
    "configured": true,
    "configSource": "kv",
    "missingRequiredFields": []
  }
}

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"
}