Get API key - Turnkey

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_api_key \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>",
    "apiKeyId": "<string>"
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "apiKey": {
        "credential": {
          "publicKey": "<string>",
          "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
        },
        "apiKeyId": "<string>",
        "apiKeyName": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "expirationSeconds": "<string>"
      }
    }
  }
}

POST

public

query

get_api_key

Authorizations

X-Stamp

string

header

required

Body

organizationId

string

required

Unique identifier for a given Organization.

apiKeyId

string

required

Unique identifier for a given API key.

Response

A successful response returns the following fields:

apiKey

object

required

apiKey field

Show apiKey details

apiKey.credential

object

required

credential field

Show credential details

apiKey.credential.publicKey

string

required

The public component of a cryptographic key pair used to sign messages and transactions.

apiKey.credential.type

enum

required

type field

Enum options: CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR, CREDENTIAL_TYPE_API_KEY_P256, CREDENTIAL_TYPE_RECOVER_USER_KEY_P256, CREDENTIAL_TYPE_API_KEY_SECP256K1, CREDENTIAL_TYPE_EMAIL_AUTH_KEY_P256, CREDENTIAL_TYPE_API_KEY_ED25519, CREDENTIAL_TYPE_OTP_AUTH_KEY_P256, CREDENTIAL_TYPE_READ_WRITE_SESSION_KEY_P256, CREDENTIAL_TYPE_OAUTH_KEY_P256, CREDENTIAL_TYPE_LOGIN

apiKey.apiKeyId

string

required

Unique identifier for a given API Key.

apiKey.apiKeyName

string

required

Human-readable name for an API Key.

apiKey.createdAt

object

required

createdAt field

Show createdAt details

apiKey.createdAt.seconds

string

required

seconds field

apiKey.createdAt.nanos

string

required

nanos field

apiKey.updatedAt

object

required

updatedAt field

Show updatedAt details

apiKey.updatedAt.seconds

string

required

seconds field

apiKey.updatedAt.nanos

string

required

nanos field

apiKey.expirationSeconds

string

Optional window (in seconds) indicating how long the API Key should last.

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_api_key \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>",
    "apiKeyId": "<string>"
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "apiKey": {
        "credential": {
          "publicKey": "<string>",
          "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
        },
        "apiKeyId": "<string>",
        "apiKeyName": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "expirationSeconds": "<string>"
      }
    }
  }
}

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_api_key \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>",
    "apiKeyId": "<string>"
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "apiKey": {
        "credential": {
          "publicKey": "<string>",
          "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
        },
        "apiKeyId": "<string>",
        "apiKeyName": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "expirationSeconds": "<string>"
      }
    }
  }
}

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_api_key \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>",
    "apiKeyId": "<string>"
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "apiKey": {
        "credential": {
          "publicKey": "<string>",
          "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
        },
        "apiKeyId": "<string>",
        "apiKeyName": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "expirationSeconds": "<string>"
      }
    }
  }
}

POST

public

query

get_api_key

Authorizations

X-Stamp

string

header

required

Body

organizationId

string

required

Unique identifier for a given Organization.

apiKeyId

string

required

Unique identifier for a given API key.

Response

A successful response returns the following fields:

apiKey

object

required

apiKey field

Show apiKey details

apiKey.credential

object

required

credential field

Show credential details

apiKey.credential.publicKey

string

required

The public component of a cryptographic key pair used to sign messages and transactions.

apiKey.credential.type

enum

required

type field

apiKey.apiKeyId

string

required

Unique identifier for a given API Key.

apiKey.apiKeyName

string

required

Human-readable name for an API Key.

apiKey.createdAt

object

required

createdAt field

Show createdAt details

apiKey.createdAt.seconds

string

required

seconds field

apiKey.createdAt.nanos

string

required

nanos field

apiKey.updatedAt

object

required

updatedAt field

Show updatedAt details

apiKey.updatedAt.seconds

string

required

seconds field

apiKey.updatedAt.nanos

string

required

nanos field

apiKey.expirationSeconds

string

Optional window (in seconds) indicating how long the API Key should last.

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_api_key \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>",
    "apiKeyId": "<string>"
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "apiKey": {
        "credential": {
          "publicKey": "<string>",
          "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
        },
        "apiKeyId": "<string>",
        "apiKeyName": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "expirationSeconds": "<string>"
      }
    }
  }
}

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_api_key \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>",
    "apiKeyId": "<string>"
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "apiKey": {
        "credential": {
          "publicKey": "<string>",
          "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
        },
        "apiKeyId": "<string>",
        "apiKeyName": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "expirationSeconds": "<string>"
      }
    }
  }
}

Authorizations

Body

Response

Changelogs

Authorizations

Body

Response