Get OAuth 2.0 credential

Get details about an OAuth 2.0 credential.

organizationId · string · required

Unique identifier for a given Organization.

oauth2CredentialId · string · required

Unique identifier for a given OAuth 2.0 Credential.

A successful response returns the following fields:

oauth2Credential · object · required

oauth2Credential field

Show oauth2Credential details

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>"
    }
  }
}