Authentication by Google

Gets the Google login URL.

get

Query parameters

callbackUrlstringRequired

The callback URL that the user will be redirected to after logging in.

returnUrlstringRequired

The return URL that the user will be redirected to after canceling the login.

typeResponsestring · enumOptional

The type response after the authentication success. The type includes the RedirectUrl or JsonFormat. By default, the type is RedirectUrl.

Possible values:

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/users/auth/integrations/google/authenticate-url HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": "https://accounts.google.com/o/oauth2/v2/auth?client_id=919781836941-bj1pshr3l3umu5kgbqkbcktul5ggu1l1.apps.googleusercontent.com&redirect_uri=https%3A%2F%2Fboostpte.com%2Fapi%2Faccounts%2Fauth%2Fgoogle%2Fcallback&response_type=code&scope=openid%20email%20profile&access_type=offline&state=h80GhRPZ52OoDZzVbhOfJhJgdno%2FOhA2eUjyVRsWDDNxwMKvfe%2BkHIoKJLeyVEtFYA7G4jP4%2FwaxGYlPYDycJKF2bXDI%2BwsCsuv289XzvtFZlEl%2FHvwMmfqIur6Y1pGi&prompt=consent",
  "errors": []
}