Toolkit Credentials

Bind credential to toolkit

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

post/toolkits/{toolkit_id}/credentials

Path parameters

toolkit_idstring required

Request body

allow_allboolean

Convenience flag: bind with a single allow rule that matches every request for this binding's vendor. Mutually exclusive with permissions.

credential_idstring required

Response

Successful Response

api_namestring nullable
api_vendorstring nullable
bound_atstring date-time required
catalog_api_idstring nullable

Catalog identity slug of the bound credential's target API (domain[/sub-api]), when recorded. Display-only.

credential_idstring required
credential_typestring nullable
labelstring nullable
toolkit_idstring required

Changes

Changed in 4 of the 85 revisions of this API.71346

    • added the optional property catalog_api_id to the response with the 201 status

      response-optional-property-added

    • added the new optional request property allow_all

      new-optional-request-property

    • added the new optional request property permissions/anyOf[subschema #1]/items/match_mode

      new-optional-request-property

    • added the optional property permissions/items/match_mode to the response with the 201 status

      response-optional-property-added

    • added the optional property warnings to the response with the 201 status

      response-optional-property-added

  • d65fcba0d25a1227See the full diff
    • the detail response's property type/format changed from array/ to string/ for status 422

      response-property-type-changed

    • removed the optional property api_id from the response with the 201 status

      response-optional-property-removed

    • removed the optional property auth_type from the response with the 201 status

      response-optional-property-removed

    • api operation id add_credential_to_toolkit_toolkits__toolkit_id__credentials_post removed and replaced with bindCredential

      api-operation-id-removed

    • the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • the endpoint scheme security HumanLogin was removed from the API

      api-security-removed

    • api tag Toolkit Credentials added

      api-tag-added

    • api tag toolkits removed

      api-tag-removed

    • added the new optional request property permissions

      new-optional-request-property

    • media type application/json was changed to a more specific media type application/problem+json for the response status 422

      response-media-type-name-specialized

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 403

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added the non-success response with the status 409

      response-non-success-status-added

    • added the non-success response with the status 500

      response-non-success-status-added

    • added the non-success response with the status 503

      response-non-success-status-added

    • added the optional property api_name to the response with the 201 status

      response-optional-property-added

    • added the optional property api_vendor to the response with the 201 status

      response-optional-property-added

    • added the optional property code to the response with the 422 status

      response-optional-property-added

    • added the optional property credential_type to the response with the 201 status

      response-optional-property-added

    • added the optional property errors to the response with the 422 status

      response-optional-property-added

    • added the optional property instance to the response with the 422 status

      response-optional-property-added

    • added the optional property permissions to the response with the 201 status

      response-optional-property-added

    • added the optional property status to the response with the 422 status

      response-optional-property-added

    • added the optional property title to the response with the 422 status

      response-optional-property-added

    • added the optional property type to the response with the 422 status

      response-optional-property-added

    • the response property detail became required for the status 422

      response-property-became-required

    • added the required property bound_at to the response with the 201 status

      response-required-property-added

    • added the required property toolkit_id to the response with the 201 status

      response-required-property-added

    This revision also has 61 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76e8f606372861114See the full diff
    • media type application/problem+json was changed to a more general media type application/json for the response status 422

      response-media-type-name-generalized

    • the response property detail became optional for the status 422

      response-property-became-optional

    • the detail response property's maxLength was unset from 4096 for the response status 422

      response-property-max-length-unset

    • the detail response's property type/format changed from string/ to array/ for status 422

      response-property-type-changed

    • removed the required property bound_at from the response with the 201 status

      response-required-property-removed

    • removed the required property toolkit_id from the response with the 201 status

      response-required-property-removed

    • removed the request property permissions

      request-property-removed

    • removed the optional property api_name from the response with the 201 status

      response-optional-property-removed

    • removed the optional property api_vendor from the response with the 201 status

      response-optional-property-removed

    • removed the optional property code from the response with the 422 status

      response-optional-property-removed

    • removed the optional property credential_type from the response with the 201 status

      response-optional-property-removed

    • removed the optional property errors from the response with the 422 status

      response-optional-property-removed

    • removed the optional property instance from the response with the 422 status

      response-optional-property-removed

    • removed the optional property permissions from the response with the 201 status

      response-optional-property-removed

    • removed the optional property status from the response with the 422 status

      response-optional-property-removed

    • removed the optional property title from the response with the 422 status

      response-optional-property-removed

    • removed the optional property type from the response with the 422 status

      response-optional-property-removed

    • api operation id bindCredential removed and replaced with add_credential_to_toolkit_toolkits__toolkit_id__credentials_post

      api-operation-id-removed

    • the endpoint scheme security HumanLogin was added to the API

      api-security-added

    • the endpoint scheme security BearerAuth was removed from the API

      api-security-removed

    • api tag toolkits added

      api-tag-added

    • api tag Toolkit Credentials removed

      api-tag-removed

    • removed the non-success response with the status 400

      response-non-success-status-removed

    • removed the non-success response with the status 401

      response-non-success-status-removed

    • removed the non-success response with the status 403

      response-non-success-status-removed

    • removed the non-success response with the status 404

      response-non-success-status-removed

    • removed the non-success response with the status 409

      response-non-success-status-removed

    • removed the non-success response with the status 500

      response-non-success-status-removed

    • removed the non-success response with the status 503

      response-non-success-status-removed

    • added the optional property api_id to the response with the 201 status

      response-optional-property-added

    • added the optional property auth_type to the response with the 201 status

      response-optional-property-added

    This revision also has 179 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog