---
title: "Bind credential to toolkit"
method: POST
path: "/toolkits/{toolkit_id}/credentials"
tags: ["Toolkit Credentials"]
---

# Bind credential to toolkit

`POST /toolkits/{toolkit_id}/credentials`

Bind an existing credential to a toolkit, optionally with inline permission rules.

## Path parameters

- `toolkit_id` string, required

## Request body

- ToolkitCredentialBindRequest — Bind a credential to a toolkit.
  - `allow_all` boolean — Convenience flag: bind with a single `allow` rule that matches every request for this binding's vendor. Mutually exclusive with `permissions`.
  - `credential_id` string, required
  - `permissions` JenticOneControlWebSchemasToolkitsPermissionRuleSchema[], nullable
    - `effect` 'allow' | 'deny', required — Whether this rule allows or denies the matched request.
    - `match_mode` 'regex' | 'prefix' | 'exact' — How `path` is interpreted: `regex` (full-match), `prefix` (string prefix), or `exact` (equality). Defaults to `regex` for backwards compatibility.
    - `methods` string[], nullable — HTTP methods to match (case-insensitive). None matches all.
    - `operations` string[], nullable — OpenAPI operation IDs to match. None matches all operations.
    - `path` string, nullable — Path pattern to match. Interpreted per `match_mode`: `regex` uses full-match semantics (the pattern must describe the whole path); `prefix` and `exact` are literal. None matches all paths.

## Response `201`

Successful Response

- ToolkitCredentialBindingResponse — Credential binding response.
  - `api_name` string, nullable
  - `api_vendor` string, nullable
  - `bound_at` string, date-time, required
  - `catalog_api_id` string, nullable — Catalog identity slug of the bound credential's target API (`domain[/sub-api]`), when recorded. Display-only.
  - `credential_id` string, required
  - `credential_type` string, nullable
  - `label` string, nullable
  - `permissions` PermissionRuleReadSchema[]
    - `_comment` string, nullable
    - `_system` boolean
    - `effect` 'allow' | 'deny', required
    - `match_mode` 'regex' | 'prefix' | 'exact'
    - `methods` string[], nullable
    - `operations` string[], nullable
    - `path` string, nullable
  - `toolkit_id` string, required
  - `warnings` BindingWarningSchema[] — Non-fatal bind-time signals — e.g. a binding that landed with zero permission rules (broker denies by default until rules are added).
    - `code` string, required — Stable machine-readable warning code.
    - `credential_id` string, nullable — Credential the warning applies to; null when the whole binding is meant.
    - `message` string, required — Human-readable explanation with a recovery pointer.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `409` — Credential already bound
- `422` — Unprocessable Entity
- `500` — Internal Server Error
- `503` — Service Unavailable

## Changes

- **2026-07-31** `3746d110464c` — 1 info
  - added the optional property `catalog_api_id` to the response with the `201` status
- **2026-07-24** `6b93e5cc002c` — 4 info
  - added the new optional request property `allow_all`
  - added the new optional request property `permissions/anyOf[subschema #1]/items/match_mode`
  - added the optional property `permissions/items/match_mode` to the response with the `201` status
  - added the optional property `warnings` to the response with the `201` status
- **2026-07-01** `d65fcba0d25a` — 1 breaking, 2 warning, 27 info
  - the `detail` response's property type/format changed from `array`/`` to `string`/`` for status `422`
  - removed the optional property `api_id` from the response with the `201` status
  - removed the optional property `auth_type` from the response with the `201` status
  - api operation id `add_credential_to_toolkit_toolkits__toolkit_id__credentials_post` removed and replaced with `bindCredential`
  - …26 more
- **2026-04-13** `76e8f6063728` — 6 breaking, 11 warning, 14 info
  - media type `application/problem+json` was changed to a more general media type `application/json` for the response status `422`
  - the response property `detail` became optional for the status `422`
  - the `detail` response property's maxLength was unset from `4096` for the response status `422`
  - the `detail` response's property type/format changed from `string`/`` to `array`/`` for status `422`
  - …27 more

[Change history](https://skmtc.dev/jentic/apis/jentic-control-plane-api/changes/toolkits/:toolkit_id/credentials/post.md)

---

[API](https://skmtc.dev/jentic/apis/jentic-control-plane-api.md) · [All operations](https://skmtc.dev/jentic/apis/jentic-control-plane-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/jentic/jentic-control-plane-api/revisions/f4594f50f4d3/schema)