Update tenant plugin configuration.

PUT

/api/admin/plugins/{id}/config

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/plugins/example/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "tenant_id": "default", "config": { "host": "smtp.example.com", "port": 587 }, "secret_fields": [ "password" ] }'

Validate and store tenant plugin configuration. Secret fields are encrypted when a key-encryption key is configured, and the response returns masked values.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Plugin identifier.

Request Body ^required

Media type application/json

object

config

required

object

key

additional properties

tenant_id

string

secret_fields

Array<string>

key

additional properties

Example

{
  "tenant_id": "default",
  "config": {
    "host": "smtp.example.com",
    "port": 587
  },
  "secret_fields": [
    "password"
  ]
}

Responses

200

Plugin configuration update response.

Media type application/json

object

success

required

boolean

pluginId

required

string

tenantId

required

string | null

config

required

object

key

additional properties

encryptedFields

required

Array<string>

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