Skip to content
Authrim

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", "resource_selections": [ { "logical_resource_id": "plugin_cache", "mode": "existing", "provider_resource_id": "4ef60e8d359f4eb59b0af5cfadf02af1", "provider_name": "existing-plugin-cache" } ] }'

Enable a plugin for the current tenant after verifying that all required configuration fields are present. Dynamic Worker plugins with dedicated resources return 202 while the Control Worker provisions and verifies those resources; the plugin remains disabled until the activation gate is ready. Dynamic Worker (external) plugins run custom code, so enabling one also needs the tenant’s plugin.enabled setting to be on (off by default); otherwise the request is refused with 403 and error external_plugin_execution_not_allowed. Built-in plugins (email providers, CAPTCHA providers) are not affected by plugin.enabled. The gate for external plugin code in ar-plugin-runner is opened from the saved setting just before the plugin is switched on; if the setting or the gate is unavailable the request is refused with 503 (temporarily_unavailable).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Plugin identifier.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
tenant_id
string
<= 256 characters
resource_selections
Array<object>
<= 16 items
object
logical_resource_id
required
string
/^[a-z0-9][a-z0-9._-]{0,127}$/
mode
required
string
Allowed values: existing
provider_resource_id
required
string
/^[a-zA-Z0-9][a-zA-Z0-9._:-]{0,255}$/
provider_name
required
string
/^[a-zA-Z0-9][a-zA-Z0-9._:-]{0,255}$/
key
additional properties
key
additional properties
Example 
{
  "tenant_id": "default",
  "resource_selections": [
    {
      "logical_resource_id": "plugin_cache",
      "mode": "existing",
      "provider_resource_id": "4ef60e8d359f4eb59b0af5cfadf02af1",
      "provider_name": "existing-plugin-cache"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Plugin enable or disable response.

Media type application/json
object
success
required
boolean
pluginId
required
string
tenantId
required
string | null
enabled
required
boolean
configSource
required
string
Allowed values: kv env default
configured
required
boolean
missingRequiredFields
required
Array<string>
provisioning
object
operationId
required
string
state
required
string
Allowed values: pending blocked
kind
required
string
Allowed values: provisioning cleanup
key
additional properties
key
additional properties
Example 
{
  "success": true,
  "configSource": "kv",
  "provisioning": {
    "state": "pending",
    "kind": "provisioning"
  }
}

202

Section titled “202 ”

Plugin enable or disable response.

Media type application/json
object
success
required
boolean
pluginId
required
string
tenantId
required
string | null
enabled
required
boolean
configSource
required
string
Allowed values: kv env default
configured
required
boolean
missingRequiredFields
required
Array<string>
provisioning
object
operationId
required
string
state
required
string
Allowed values: pending blocked
kind
required
string
Allowed values: provisioning cleanup
key
additional properties
key
additional properties
Example 
{
  "success": true,
  "configSource": "kv",
  "provisioning": {
    "state": "pending",
    "kind": "provisioning"
  }
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}

503

Section titled “503 ”

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