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

This enum represents the response client for the AppSettingAuthenticationTypeResponseClient.

Possible values:

Header parameters

Brand-URLstringRequired

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

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

datastring · nullableOptional

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/users/auth/integrations/google/authenticate-url

HTTPcURLJavaScriptPython

GET /api/v1/users/auth/integrations/google/authenticate-url?callbackURL=text&returnURL=text HTTP/1.1
Host: protocol.jframework.io
Brand-URL: 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": []
}