Get OAuth login info
Retrieves information about the OAuth2 login
GET
/{apiBasePath}/oauth/logininfoPath parameters
apiBasePathstringrequiredIts value depends on the apiBasePath set by the user
Query parameters
loginChallengestringrequiredResponses
200Information about the current login flow
One of:
object
statusstatusOKrequiredSuccess status indicator
Allowed:
OKinfoobjectrequiredInformation about the current login flow
Show propertiesHide properties
clientIdstringrequiredThe ID of the client.
clientNamestringThe name of the client.
tosUristringThe URI of the client's terms of service.
policyUristringThe URI of the client's privacy policy.
logoUristringThe URI of the client's logo.
clientUristringThe URI of the client we can link to on the login page
generalErrorResponse
statusstringError status code
Allowed:
GENERAL_ERRORmessagestringError message
400OAuth2 specific error response
errorstringThe OAuth2 error code
error_descriptionstringHuman readable error description
404Resource not found error
string500Internal server error
stringTry it
Server
Parameters
Request
curl -X GET "/auth/oauth/logininfo?loginChallenge=string"const response = await fetch("/auth/oauth/logininfo?loginChallenge=string", {
method: "GET"
});import requests
response = requests.get(
"/auth/oauth/logininfo?loginChallenge=string",
)Response
{
"status": "OK",
"info": {
"clientId": "string",
"clientName": "string",
"tosUri": "string",
"policyUri": "string",
"logoUri": "string",
"clientUri": "string"
}
}{
"error": "invalid_request",
"error_description": "Unsupported grant type: password"
}"Not Found""Internal Error"