Sign in

Delete admin API key

Delete an organization admin API key

delete/organization/admin_api_keys/{key_id}

Path parameters

key_idstring required

The ID of the API key to be deleted.

Response

Confirmation that the API key was deleted.

idstring required
object'organization.admin_api_key.deleted' required
deletedboolean required

Example response

{
  "id": "key_abc",
  "object": "organization.admin_api_key.deleted",
  "deleted": true
}

Changes

Changed in 6 of the 163 revisions of this API.113

  • d86203de41ae2See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 74cbcf73838f14See the full diff
    • ●

      added the new organization.admin_api_key.deleted enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      the endpoint scheme security AdminApiKeyAuth was added to the API

      api-security-added

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

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

  • fc164a27fdb92See the full diff
    • ○

      the endpoint scheme security basic_identity_edge was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security bearer_identity_edge was removed from the API

      api-security-removed

  • 15156e46769c2See the full diff
    • ○

      the endpoint scheme security basic_identity_edge was added to the API

      api-security-added

    • ○

      the endpoint scheme security bearer_identity_edge was added to the API

      api-security-added

  • bdebcdfcbbde2See the full diff
    • ○

      the endpoint scheme security basic_identity_edge was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security bearer_identity_edge was removed from the API

      api-security-removed

  • d311deacd11a1See the full diff
    • ○

      endpoint added

      endpoint-added