Skip to main content
GET
/
auth
Start OAuth authorization
curl --request GET \
  --url https://auth.endaoment.org/auth

Query Parameters

response_type
enum<string>
required

Must be code for the Authorization Code flow.

Available options:
code
client_id
string
required

OAuth client ID issued by Endaoment.

redirect_uri
string<uri>
required

Registered callback URL. Must match exactly in the later token exchange.

scope
string
required

Space-delimited OAuth scopes. Common value: openid accounts transactions profile email address. Add offline_access for refresh tokens — include prompt=consent on this request or refresh tokens are silently omitted.

code_challenge
string
required

PKCE code challenge (S256 hash of the stored code_verifier).

code_challenge_method
enum<string>
required

PKCE challenge method. Endaoment supports S256 only.

Available options:
S256
state
string
required

Random value your backend can verify on callback to prevent CSRF.

prompt
enum<string>

Use consent when requesting offline_access to ensure a refresh token can be issued.

Available options:
consent

Response

Redirect to Endaoment login, or back to redirect_uri with code and state after successful authentication