Skip to content
Dashboard
Theme
Theme

Delete a directory

DELETE /v1/directories/{dir}: Delete a directory.

View Markdown

DELETE /v1/directories/{dir}

Scope
directories:write
Auth
Secret key (sk_…)
Since
1.0
  • dir string Required

  • confirm string

    Optional. When given, it must equal the directory ID, as with deleting a connection; the delete is refused otherwise.

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • Idempotency-Key string

    Honoured for 24 h; a replay returns the original response.

    min length 1 · max length 255

Errors share one shape; see the error code catalogue.

curl -X DELETE \
"https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY"
Response 200
{
"id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"deleted": true
}