Delete protocol mapper
delete_protocol_mapperDelete a protocol mapper for a client by specifying the mapper UUID. Use dry run mode to preview the deletion before applying.
Instructions
Delete one of a client's protocol mappers by mapper UUID. With write=false (default) it reports which mapper would be deleted; write=true performs the deletion.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | Yes | Target Keycloak host key, as configured in the config file's "hosts" map (or the KC_<HOST>_* env fallback). A host whose "production" flag is true, or absent, is treated as PRODUCTION and its writes are gated by "allowProdWrite". | |
| realm | Yes | Target realm name for the operation. | |
| write | No | false (default) = dry run: report what would happen without changing anything. true = apply the change. Production hosts additionally require KC_ALLOW_PROD_WRITE=true in the server environment. | |
| clientId | Yes | The client's clientId (the human-readable OAuth client id, not the UUID). | |
| mapperId | Yes | UUID of the protocol mapper (see list_protocol_mappers). |