Skip to content
OTA-Pulse Docs

Oauth Authorize

GET
/api/oauth/authorize
 
curl --request GET \
  --url 'https://example.com/api/oauth/authorize?client_id=example&redirect_uri=example&response_type=code&scope=openid%20profile%20email'

OAuth2 Authorization endpoint.

If user is authenticated, generates an authorization code and redirects. If not authenticated, redirects to login page.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
client_id
required
Client Id
string
redirect_uri
required
Redirect Uri
string
response_type
Response Type
string
default: code
scope
Scope
string
default: openid profile email
state
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
Example generated 
example

422

Section titled “ 422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated 
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}