Get Oauth providers

Get details about Oauth providers for a user.

POST

/

public

/

v1

/

query

/

get_oauth_providers

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.

userId · string

Unique identifier for a given user.

Response

A successful response returns the following fields:

oauthProviders · array · required

A list of Oauth providers.

Show oauthProviders details

oauthProviders.providerId

string

required

Unique identifier for an OAuth Provider

oauthProviders.providerName

string

required

Human-readable name to identify a Provider.

oauthProviders.issuer

string

required

The issuer of the token, typically a URL indicating the authentication server, e.g https://accounts.google.com

oauthProviders.audience

string

required

Expected audience (‘aud’ attribute of the signed token) which represents the app ID

oauthProviders.subject

string

required

Expected subject (‘sub’ attribute of the signed token) which represents the user ID

oauthProviders.createdAt

object

required

createdAt field

Show createdAt details

oauthProviders.createdAt.seconds

string

required

seconds field

oauthProviders.createdAt.nanos

string

required

nanos field

oauthProviders.updatedAt

object

required

updatedAt field

Show updatedAt details

oauthProviders.updatedAt.seconds

string

required

seconds field

oauthProviders.updatedAt.nanos

string

required

nanos field

cURL

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

200

{
  "oauthProviders": [
    {
      "providerId": "<string>",
      "providerName": "<string>",
      "issuer": "<string>",
      "audience": "<string>",
      "subject": "<string>",
      "createdAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      },
      "updatedAt": {
        "seconds": "<string>",
        "nanos": "<string>"
      }
    }
  ]
}