Get app integration authenticate URLs

Gets the app integration authenticate URLs.

get

Get app integration authenticate URLs for the given callback URL, return URL, device code, and type response.

Query parameters

callbackURLstringRequired

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

returnURLstringRequired

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

deviceCodestringOptional

The device code. It is the code that the user will be detected as a device.

typeResponsestring · enumOptional

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

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

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/users/auth/app-integration/authenticate-urls HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "appName": "Google",
      "logoURL": "https://www.google.com/logo.png",
      "authenticateURL": "https://accounts.google.com/o/oauth2/v2/auth"
    }
  ],
  "errors": []
}