Enable a tenant plugin.

PUT

/api/admin/plugins/{id}/enable

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/plugins/example/enable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "tenant_id": "default" }'

Enable a plugin for the current tenant after verifying that all required configuration fields are present.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Plugin identifier.

Request Body ^required

Media type application/json

object

tenant_id

string

key

additional properties

Example

{
  "tenant_id": "default"
}

Responses

200

Plugin enable or disable response.

Media type application/json

object

success

required

boolean

pluginId

required

string

tenantId

required

string | null

enabled

required

boolean

key

additional properties

Example

{
  "success": true
}

400

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

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