API reference · schema

CredentialRequest

7 fields · used by 1 operations

Last reviewed 2026-10-02

Fields

Field	Type	Meaning
`name` required	string	min length `1` · max length `63`
`kind`	string	bearer, header, basic (user:password) or query default `"bearer"`
`secret` required	string	min length `1` · max length `8192`
`allowed_hosts` required	array of string	min items `1` · max items `20`
`allowed_methods`	array of string
`header_name`	string or null	max length `64`
`description`	string or null	max length `200`

Smallest valid example

{
  "name": "name",
  "kind": "bearer",
  "secret": "secret",
  "allowed_hosts": [
    "allowed-hosts"
  ]
}

Used by 1 operation

POST /fabric/broker/credentials Store a credential agents can use without seeing it

JSON Schema

Show the raw definition

{
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 63,
      "minLength": 1,
      "title": "Name"
    },
    "kind": {
      "type": "string",
      "title": "Kind",
      "description": "bearer, header, basic (user:password) or query",
      "default": "bearer"
    },
    "secret": {
      "type": "string",
      "maxLength": 8192,
      "minLength": 1,
      "title": "Secret"
    },
    "allowed_hosts": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "maxItems": 20,
      "minItems": 1,
      "title": "Allowed Hosts"
    },
    "allowed_methods": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Allowed Methods"
    },
    "header_name": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ],
      "title": "Header Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 200
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    }
  },
  "type": "object",
  "required": [
    "name",
    "secret",
    "allowed_hosts"
  ],
  "title": "CredentialRequest"
}

Try CAIN-42 on your own agents

Create a free account and every new account starts with a 7-day trial of the full platform. Or try the sandbox first, with no account at all.

Create a free account → · Try the sandbox · See the whole ecosystem