Get third party auth URL

Get the thirdparty provider’s authorisation URL to which the user should be redirected to.

GET/{apiBasePath}/{tenantId}/authorisationurl

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

tenantIdstring

The tenant against which the request is made. If left empty, the default tenant will be used.

Query parameters

thirdPartyIdthirdPartyIdrequired

redirectURIOnProviderDashboardredirectURIrequired

clientTypeclientType

Header parameters

ridstring

The third party recipe ID

Responses

200Get the OAuth authorisation URL

One of:

object

statusstatusOKrequired

Success status indicator

Allowed:OK

urlWithQueryParamsstring

pkceCodeVerifierstring

generalErrorResponse

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the usertenantIdpath*The tenant against which the request is made. If left empty, the default tenant will be used.ridheaderThe third party recipe IDthirdPartyIdquery*redirectURIOnProviderDashboardquery*clientTypequery

Request

curl -X GET "/auth/public/authorisationurl?thirdPartyId=google&redirectURIOnProviderDashboard=https%3A%2F%2Fyourdomain.com%2Fcallback"

const response = await fetch("/auth/public/authorisationurl?thirdPartyId=google&redirectURIOnProviderDashboard=https%3A%2F%2Fyourdomain.com%2Fcallback", {
  method: "GET"
});

import requests

response = requests.get(
    "/auth/public/authorisationurl?thirdPartyId=google&redirectURIOnProviderDashboard=https%3A%2F%2Fyourdomain.com%2Fcallback",
)

Response

{
  "status": "OK",
  "urlWithQueryParams": "https://providerdomain.com/authorize?client_id=..&scope=..&access_type=..",
  "pkceCodeVerifier": "abcd1234"
}

"Not Found"

"Internal Error"