List OAuth 2.0 Credentials

List all OAuth 2.0 credentials within an organization.

POST

/

public

/

v1

/

query

/

list_oauth2_credentials

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.

Response

A successful response returns the following fields:

oauth2Credentials · array · required

oauth2Credentials field

Show oauth2Credentials details

oauth2Credentials.oauth2CredentialId

string

required

Unique identifier for a given OAuth 2.0 Credential.

oauth2Credentials.organizationId

string

required

Unique identifier for an Organization.

oauth2Credentials.provider

enum

required

provider field

Enum options: OAUTH2_PROVIDER_X, OAUTH2_PROVIDER_DISCORD

oauth2Credentials.clientId

string

required

The client id for a given OAuth 2.0 Credential.

oauth2Credentials.encryptedClientSecret

string

required

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

oauth2Credentials.createdAt

object

required

createdAt field

Show createdAt details

oauth2Credentials.createdAt.seconds

string

required

seconds field

oauth2Credentials.createdAt.nanos

string

required

nanos field

oauth2Credentials.updatedAt

object

required

updatedAt field

Show updatedAt details

oauth2Credentials.updatedAt.seconds

string

required

seconds field

oauth2Credentials.updatedAt.nanos

string

required

nanos field

cURL

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

200

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