Delete API Keys

Remove api keys from a User

POST

/

public

/

v1

/

submit

/

delete_api_keys

Authorizations

API Key

X-Stamp

string

header

required

Webauthn (Passkey)

X-Stamp-Webauthn

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_DELETE_API_KEYS

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

Show details

parameters.userId

string

required

Unique identifier for a given User.

parameters.apiKeyIds · array · required

A list of API Key IDs.

Show item details

Array item type: string

item field

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.deleteApiKeysIntent

object

required

The deleteApiKeysIntent object

Show deleteApiKeysIntent details

activity.intent.deleteApiKeysIntent.userId

string

required

Unique identifier for a given User.

activity.intent.deleteApiKeysIntent.apiKeyIds

array

required

A list of API Key IDs.

Show apiKeyIds details

activity.intent.deleteApiKeysIntent.apiKeyIds.item

string

required

item field

activity.result

object

required

The result of the activity

Show result details

activity.result.deleteApiKeysResult

object

required

The deleteApiKeysResult object

Show deleteApiKeysResult details

activity.result.deleteApiKeysResult.apiKeyIds

array

required

A list of API Key IDs.

Show apiKeyIds details

activity.result.deleteApiKeysResult.apiKeyIds.item

string

required

item field

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/delete_api_keys \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_DELETE_API_KEYS",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "userId": "<string>",
        "apiKeyIds": [
            "<string_element>"
        ]
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_DELETE_API_KEYS",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "deleteApiKeysIntent": {
            "userId": "<string>",
            "apiKeyIds": [
              "<string_element>"
            ]
          }
        },
        "result": {
          "deleteApiKeysResult": {
            "apiKeyIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}