OAuth 2.0 Authenticate

curl --request POST \
  --url https://authproxy.turnkey.com/v1/oauth2_authenticate \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Auth-Proxy-Config-Id: <string> (see Authorizations)" \
  --data '{
    "provider": "<OAUTH2_PROVIDER_X>",
    "authCode": "<string>",
    "redirectUri": "<string>",
    "codeVerifier": "<string>",
    "nonce": "<string>",
    "clientId": "<string>"
}'

{
  "oidcToken": "<string>"
}

curl --request POST \
  --url https://authproxy.turnkey.com/v1/oauth2_authenticate \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Auth-Proxy-Config-Id: <string> (see Authorizations)" \
  --data '{
    "provider": "<OAUTH2_PROVIDER_X>",
    "authCode": "<string>",
    "redirectUri": "<string>",
    "codeVerifier": "<string>",
    "nonce": "<string>",
    "clientId": "<string>"
}'

{
  "oidcToken": "<string>"
}

POST

https://authproxy.turnkey.com/v1/oauth2_authenticate

string

required

Your Auth Proxy config ID, found in Dashboard → AUTH. See Auth Proxy reference for setup.

enum<string>

required

Enum options: OAUTH2_PROVIDER_X, OAUTH2_PROVIDER_DISCORD

string

required

The auth_code provided by the OAuth 2.0 to the end user to be exchanged for a Bearer token in the OAuth 2.0 flow

string

required

The URI the user is redirected to after they have authenticated with the OAuth 2.0 provider

string

required

The code verifier used by OAuth 2.0 PKCE providers

string

required

A nonce value set to sha256(publicKey), used to bind the OIDC token to a specific public key

string

required

The client ID registered with the OAuth 2.0 provider

A successful response returns the following fields:

string

required

A Turnkey issued OIDC token to be used with the LoginWithOAuth activity

curl --request POST \
  --url https://authproxy.turnkey.com/v1/oauth2_authenticate \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Auth-Proxy-Config-Id: <string> (see Authorizations)" \
  --data '{
    "provider": "<OAUTH2_PROVIDER_X>",
    "authCode": "<string>",
    "redirectUri": "<string>",
    "codeVerifier": "<string>",
    "nonce": "<string>",
    "clientId": "<string>"
}'

{
  "oidcToken": "<string>"
}

REST API

SDK reference

OAuth 2.0 Authenticate