Disable an API key

JavaScript

import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const apiKey = await client.apiKeys.disable('apikey_01HXKD2E5NQM3T9AYWCFCSPNQY', {
  workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});

console.log(apiKey.metadata);

import os
from cadenya import Cadenya

client = Cadenya(
    api_key=os.environ.get("CADENYA_API_KEY"),  # This is the default and can be omitted
)
api_key = client.api_keys.disable(
    id="apikey_01HXKD2E5NQM3T9AYWCFCSPNQY",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(api_key.metadata)

package main

import (
	"context"
	"fmt"
	"go.cadenya.com/cadenya-go"
	"go.cadenya.com/cadenya-go/option"
)

func main() {
	client := cadenya.NewClient(
		option.WithAPIKey("My API Key"),
	)
	apiKey, err := client.APIKeys.Disable(
		context.TODO(),
		"apikey_01HXKD2E5NQM3T9AYWCFCSPNQY",
		cadenya.APIKeyDisableParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", apiKey.Metadata)
}

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

api_key = cadenya.api_keys.disable(
  "apikey_01HXKD2E5NQM3T9AYWCFCSPNQY",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(api_key)

curl --request POST \
  --url https://api.cadenya.com/v1/workspaces/{workspaceId}/api_keys/{id}:disable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/api_keys/{id}:disable",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://api.cadenya.com/v1/workspaces/{workspaceId}/api_keys/{id}:disable")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "name": "<string>",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "externalId": "<string>",
    "labels": {},
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "spec": {
    "token": "<string>",
    "description": "<string>",
    "permissions": [
      "<string>"
    ],
    "system": true
  },
  "info": {
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "externalId": "<string>",
        "labels": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>"
      }
    }
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

POST

workspaces

{workspaceId}

api_keys

{id}

:disable

JavaScript

import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const apiKey = await client.apiKeys.disable('apikey_01HXKD2E5NQM3T9AYWCFCSPNQY', {
  workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});

console.log(apiKey.metadata);

import os
from cadenya import Cadenya

client = Cadenya(
    api_key=os.environ.get("CADENYA_API_KEY"),  # This is the default and can be omitted
)
api_key = client.api_keys.disable(
    id="apikey_01HXKD2E5NQM3T9AYWCFCSPNQY",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(api_key.metadata)

package main

import (
	"context"
	"fmt"
	"go.cadenya.com/cadenya-go"
	"go.cadenya.com/cadenya-go/option"
)

func main() {
	client := cadenya.NewClient(
		option.WithAPIKey("My API Key"),
	)
	apiKey, err := client.APIKeys.Disable(
		context.TODO(),
		"apikey_01HXKD2E5NQM3T9AYWCFCSPNQY",
		cadenya.APIKeyDisableParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", apiKey.Metadata)
}

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

api_key = cadenya.api_keys.disable(
  "apikey_01HXKD2E5NQM3T9AYWCFCSPNQY",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(api_key)

curl --request POST \
  --url https://api.cadenya.com/v1/workspaces/{workspaceId}/api_keys/{id}:disable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/api_keys/{id}:disable",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://api.cadenya.com/v1/workspaces/{workspaceId}/api_keys/{id}:disable")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "name": "<string>",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "externalId": "<string>",
    "labels": {},
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "spec": {
    "token": "<string>",
    "description": "<string>",
    "permissions": [
      "<string>"
    ],
    "system": true
  },
  "info": {
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "externalId": "<string>",
        "labels": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>"
      }
    }
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

Disabling stops a key’s token from authenticating anywhere, while the key itself (name, scopes, history) stays put. It is the move for a suspected leak or an offboarded integration: instant, reversible, and nothing to re-provision if you were wrong.

const key = await client.apiKeys.disable(apiKeyId, { workspaceId });
console.log(key.state); // STATE_DISABLED

const back = await client.apiKeys.enable(apiKeyId, { workspaceId });
console.log(back.state); // STATE_ENABLED

key, err := client.APIKeys.Disable(ctx, apiKeyID,
	cadenya.APIKeyDisableParams{WorkspaceID: cadenya.String(workspaceID)})
if err != nil {
	log.Fatal(err)
}
log.Println(key.State) // STATE_DISABLED

back, err := client.APIKeys.Enable(ctx, apiKeyID,
	cadenya.APIKeyEnableParams{WorkspaceID: cadenya.String(workspaceID)})
if err != nil {
	log.Fatal(err)
}
log.Println(back.State) // STATE_ENABLED

key = cadenya.api_keys.disable(api_key_id, workspace_id: workspace_id)
puts key.state # STATE_DISABLED

back = cadenya.api_keys.enable(api_key_id, workspace_id: workspace_id)
puts back.state # STATE_ENABLED

curl -X POST "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/api_keys/${API_KEY_ID}:disable" \
  -H "Authorization: Bearer ${CADENYA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{}'

The action is idempotent: disabling a disabled key returns 200 and changes nothing.

Disable, rotate, or delete

Three ways to take a token out of service, three different blast radii:

Action	Token	Key	Reversible
Disable	Fails auth	Kept	Yes, enable
Rotate	Replaced	Kept	No, old token is gone
Delete	Dead	Gone	No

A caller presenting a disabled key’s token gets an authentication failure, not a scope denial. The difference in the error body is covered in reading a denial.

Enable an API key

The other half of the switch.

Disable the global API key

The same switch on the account-wide key.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId

string

required

The workspace the API key belongs to (path).

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

string

required

The API key to disable.

Example:

"apikey_01HXKD2E5NQM3T9AYWCFCSPNQY"

Body

application/json

The body is of type object.

Response

An API key. Every key belongs to exactly one workspace and is managed via the workspace-scoped API key routes. The only exception is the system-managed global account key, which spans all workspaces and is managed via the account global_api_key routes.

metadata

object

required

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

Show child attributes

spec

object

required

Configuration for an API key.

Show child attributes

state

enum<string>

required

read-only

The current lifecycle state of the API key. Output only. Keys are created STATE_ENABLED; use the :disable and :enable actions to transition between states.

Available options:

STATE_UNSPECIFIED,

STATE_ENABLED,

STATE_DISABLED

info

object

Show child attributes

​Disable, rotate, or delete

​Related

Enable an API key

Disable the global API key

Authorizations

Path Parameters

Body

Response

Disable, rotate, or delete

Related