Get OAuth 2.0 credential

Get details about an OAuth 2.0 credential.

POST

/

public

/

v1

/

query

/

get_oauth2_credential

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

organizationId · string · required

Unique identifier for a given Organization.

oauth2CredentialId · string · required

Unique identifier for a given OAuth 2.0 Credential.

Response

A successful response returns the following fields:

oauth2Credential · object · required

oauth2Credential field

Show oauth2Credential details

oauth2Credential.oauth2CredentialId

string

required

Unique identifier for a given OAuth 2.0 Credential.

oauth2Credential.organizationId

string

required

Unique identifier for an Organization.

oauth2Credential.provider

enum

required

provider field

Enum options: OAUTH2_PROVIDER_X, OAUTH2_PROVIDER_DISCORD

oauth2Credential.clientId

string

required

The client id for a given OAuth 2.0 Credential.

oauth2Credential.encryptedClientSecret

string

required

The encrypted client secret for a given OAuth 2.0 Credential encrypted to the TLS Fetcher quorum key.

oauth2Credential.createdAt

object

required

createdAt field

Show createdAt details

oauth2Credential.createdAt.seconds

string

required

seconds field

oauth2Credential.createdAt.nanos

string

required

nanos field

oauth2Credential.updatedAt

object

required

updatedAt field

Show updatedAt details

oauth2Credential.updatedAt.seconds

string

required

seconds field

oauth2Credential.updatedAt.nanos

string

required

nanos field

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_oauth2_credential \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "oauth2CredentialId": "<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().getOauth2Credential({
  organizationId: "<string> (Unique identifier for a given Organization.)",
  oauth2CredentialId: "<string> (Unique identifier for a given OAuth 2.0 Credential.)"
});

200

{
  "oauth2Credential": {
    "oauth2CredentialId": "<string>",
    "organizationId": "<string>",
    "provider": "<OAUTH2_PROVIDER_X>",
    "clientId": "<string>",
    "encryptedClientSecret": "<string>",
    "createdAt": {
      "seconds": "<string>",
      "nanos": "<string>"
    },
    "updatedAt": {
      "seconds": "<string>",
      "nanos": "<string>"
    }
  }
}