Toolkits

Create toolkit

Create a toolkit and issue its first API key.

The plaintext key (jntc_live_…) is returned once in api_key and is never retrievable again. Optional credential_ids bind existing credentials at creation time; each inline bind emits a no_permission_rules warning because the broker denies by default until rules are added.

post/toolkits

Request body

activeboolean
credential_idsstring[] nullable
descriptionstring nullable
namestring required

Response

Successful Response

api_keystring required

Changes

Changed in 5 of the 85 revisions of this API.102249

    • added the optional property toolkit/apis to the response with the 201 status

      response-optional-property-added

  • 6b93e5cc002c111See the full diff
    • removed the required property toolkit/permissions from the response with the 201 status

      response-required-property-removed

    • removed the request property permissions

      request-property-removed

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

      response-optional-property-added

    • added the optional property toolkit/created_by to the response with the 201 status

      response-optional-property-added

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

      response-property-type-changed

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

      response-required-property-removed

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

      response-required-property-removed

    • the name request property's maxLength was set to 255

      request-property-max-length-set

    • removed the request property initial_key_allowed_ips

      request-property-removed

    • removed the request property initial_key_label

      request-property-removed

    • removed the request property simulate

      request-property-removed

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

      response-optional-property-removed

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

      response-optional-property-removed

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

      response-optional-property-removed

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

      response-optional-property-removed

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

      response-optional-property-removed

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

      response-optional-property-removed

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

      response-optional-property-removed

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

      response-optional-property-removed

    • api operation id create_toolkit_toolkits_post removed and replaced with createToolkit

      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 Toolkits added

      api-tag-added

    • api tag toolkits removed

      api-tag-removed

    • added the new optional request property active

      new-optional-request-property

    • added the new optional request property credential_ids

      new-optional-request-property

    • 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 500

      response-non-success-status-added

    • added the non-success response with the status 503

      response-non-success-status-added

    • added the optional property code to the response with the 422 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 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 api_key to the response with the 201 status

      response-required-property-added

    • added the required property toolkit 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

  • 76e8f60637286923See 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 api_key from the response with the 201 status

      response-required-property-removed

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

      response-required-property-removed

    • removed the request property active

      request-property-removed

    • removed the request property credential_ids

      request-property-removed

    • removed the request property permissions

      request-property-removed

    • removed the optional property code from the response with the 422 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 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 createToolkit removed and replaced with create_toolkit_toolkits_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 Toolkits removed

      api-tag-removed

    • added the new optional request property initial_key_allowed_ips

      new-optional-request-property

    • added the new optional request property initial_key_label

      new-optional-request-property

    • added the new optional request property simulate

      new-optional-request-property

    • 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 500

      response-non-success-status-removed

    • removed the non-success response with the status 503

      response-non-success-status-removed

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-required-property-added

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

      response-required-property-added

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