Delete private key tags

Delete private key tags within an organization.

POST

/

public

/

v1

/

submit

/

delete_private_key_tags

Authorizations

API Key

X-Stamp · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

WebAuthn (Passkey)

X-Stamp-WebAuthn · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS

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

The parameters object containing the specific intent data for this activity.

Show details

parameters.privateKeyTagIds · array · required

A list of Private Key Tag IDs.

Show item details

Array item type: string

item field

generateAppProofs · boolean

Enable to have your activity generate and return App Proofs, enabling verifiability.

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.id

string

required

Unique identifier for a given Activity object.

activity.organizationId

string

required

Unique identifier for a given Organization.

activity.status

string

required

The activity status

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.deletePrivateKeyTagsIntent

object

required

The deletePrivateKeyTagsIntent object

Show deletePrivateKeyTagsIntent details

activity.intent.deletePrivateKeyTagsIntent.privateKeyTagIds

array

required

A list of Private Key Tag IDs.

Show privateKeyTagIds details

activity.intent.deletePrivateKeyTagsIntent.privateKeyTagIds.item

string

required

item field

activity.result

object

required

The result of the activity

Show result details

activity.result.deletePrivateKeyTagsResult

object

required

The deletePrivateKeyTagsResult object

Show deletePrivateKeyTagsResult details

activity.result.deletePrivateKeyTagsResult.privateKeyTagIds

array

required

A list of Private Key Tag IDs.

Show privateKeyTagIds details

activity.result.deletePrivateKeyTagsResult.privateKeyTagIds.item

string

required

item field

activity.result.deletePrivateKeyTagsResult.privateKeyIds

array

required

A list of Private Key IDs.

Show privateKeyIds details

activity.result.deletePrivateKeyTagsResult.privateKeyIds.item

string

required

item field

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/delete_private_key_tags \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "privateKeyTagIds": [
            "<string>"
        ]
    }
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().deletePrivateKeyTags({
  privateKeyTagIds: ["<string>"] // A list of Private Key Tag IDs.
});

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "deletePrivateKeyTagsIntent": {
            "privateKeyTagIds": [
              "<string>"
            ]
          }
        },
        "result": {
          "deletePrivateKeyTagsResult": {
            "privateKeyTagIds": [
              "<string>"
            ],
            "privateKeyIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}