API ReferenceO Auth
Authorize request
Validate an authorization request and return consent metadata (app details, requested scopes, and the organizations the signed-in user may connect). Requires an authenticated user session.
Query Parameters
client_id*string
OAuth app client ID.
redirect_uri*string
Must exactly match the app's registered redirect URI.
scope?string
Space- or comma-separated scopes. Defaults to the app's declared scopes.
state?string
Opaque value echoed back on redirect (CSRF protection).
actor?string
Token actor mode.
code_challenge?string
PKCE code challenge.
code_challenge_method?string
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/oauth/authorize?client_id=string&redirect_uri=string"{
"client_id": "string",
"app": {
"name": "string",
"description": "string",
"logo_url": "string"
},
"actor": "app",
"redirect_uri": "string",
"scopes": [
"string"
],
"scope_details": {
"property1": "string",
"property2": "string"
},
"state": "string",
"eligible_organizations": [
{
"id": "string",
"name": "string",
"domain": "string"
}
]
}{
"error": "insufficient_scope",
"error_description": "The token is missing a required scope."
}{
"error": "insufficient_scope",
"error_description": "The token is missing a required scope."
}