Start OAuth login

Starts the OAuth2 login flow - for a detailed description of all input parameters please see the OAuth2 and OpenID Connect Core specs

GET/{apiBasePath}/oauth/auth

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Responses

200A general error response

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

302Redirects the user to the login page or back to the client app

400OAuth2 specific error response

errorstring

The OAuth2 error code

error_descriptionstring

Human readable error description

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 user

Request

curl -X GET "/auth/oauth/auth"

const response = await fetch("/auth/oauth/auth", {
  method: "GET"
});

import requests

response = requests.get(
    "/auth/oauth/auth",
)

Response

{
  "status": "GENERAL_ERROR",
  "message": "string"
}

{
  "error": "invalid_request",
  "error_description": "Unsupported grant type: password"
}

"Not Found"

"Internal Error"