コンテンツにスキップ
Authrim

Uninstall a tenant Dynamic Worker plugin.

POST
/api/admin/plugins/{id}/uninstall
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/plugins/example/uninstall \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "tenant_id": "default", "idempotency_key": "admin-plugin-uninstall:019c4b08-8d71-7000-8000-000000000001", "confirmation": "UNINSTALL" }'

Disables the tenant plugin immediately, removes only its generated host bindings, waits for the fixed 30-minute quarantine, deletes Authrim-managed Cloudflare resources, and detaches existing resources without deleting them. Cleanup runs as a Control DB operation.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Dynamic Worker plugin identifier.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
tenant_id
required
string
<= 256 characters
idempotency_key
required
string
/^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$/
confirmation
required
string
Allowed values: UNINSTALL
key
additional properties
Example 
{
  "tenant_id": "default",
  "idempotency_key": "admin-plugin-uninstall:019c4b08-8d71-7000-8000-000000000001",
  "confirmation": "UNINSTALL"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Dynamic Worker plugin uninstall operation response.

Media type application/json
object
success
required
boolean
pluginId
required
string
tenantId
required
string
enabled
required
boolean
cleanup
required
One of:
object
operationId
required
string
environmentId
required
string
pluginInstallationId
required
string
tenantId
required
string
pluginId
required
string
sourceOperationId
required
string
lifecycleGeneration
required
integer
>= 1
reason
required
string
Allowed values: uninstall canceled_pre_activation
state
required
string
Allowed values: requested removing_bindings quarantined deleting_resources verifying_absence succeeded blocked
drainNotBefore
required
integer | null
managedResourceCount
required
integer
detachedResourceCount
required
integer
lastErrorCode
required
string | null
createdAt
required
integer
updatedAt
required
integer
completedAt
required
integer | null
key
additional properties
key
additional properties
Example 
{
  "success": true,
  "enabled": false,
  "cleanup": {
    "reason": "uninstall",
    "state": "requested"
  }
}

202

Section titled “202 ”

Dynamic Worker plugin uninstall operation response.

Media type application/json
object
success
required
boolean
pluginId
required
string
tenantId
required
string
enabled
required
boolean
cleanup
required
One of:
object
operationId
required
string
environmentId
required
string
pluginInstallationId
required
string
tenantId
required
string
pluginId
required
string
sourceOperationId
required
string
lifecycleGeneration
required
integer
>= 1
reason
required
string
Allowed values: uninstall canceled_pre_activation
state
required
string
Allowed values: requested removing_bindings quarantined deleting_resources verifying_absence succeeded blocked
drainNotBefore
required
integer | null
managedResourceCount
required
integer
detachedResourceCount
required
integer
lastErrorCode
required
string | null
createdAt
required
integer
updatedAt
required
integer
completedAt
required
integer | null
key
additional properties
key
additional properties
Example 
{
  "success": true,
  "enabled": false,
  "cleanup": {
    "reason": "uninstall",
    "state": "requested"
  }
}

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