Skip to content
Authrim

Disable a tenant plugin.

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

Disable a plugin for the current tenant and return the updated enabled state. A built-in human verification provider is refused with 409 while a flow requires it; both the canonical settings document and the KV copy are read, and either one requiring it counts. Known limit: a settings PATCH that makes a flow required and this disable, run at the same time, can both pass their checks; serialising them would need a shared coordinator.

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
key
additional properties
Example 
{
  "tenant_id": "default"
}

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

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

409

Section titled “409 ”

A built-in human verification (CAPTCHA) provider cannot be disabled while a flow of the tenant requires it (error: human_verification_provider_in_use, with settings naming the authentication-methods.human_verification.*_enabled settings that require it). Turn those settings off first.

Media type application/json
object
error
required
string
Allowed values: human_verification_provider_in_use
error_description
string
plugin_id
string
settings
Array<string>
Example 
{
  "error": "human_verification_provider_in_use"
}

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 ”

The tenant settings (the canonical document or the KV copy) could not be read to check whether a human verification provider is required (reason: settings_unavailable), so nothing was changed; try again. A malformed settings document counts as requiring nothing.

Media type application/json
object
error
required
string
Allowed values: temporarily_unavailable
error_description
string
reason
string
Allowed values: settings_unavailable
plugin_id
string
Example 
{
  "error": "temporarily_unavailable",
  "reason": "settings_unavailable"
}