Skip to main content

OAuthFlowResponse

authUrlstring

URL to redirect user to for OAuth authorization

Example: https://github.com/login/oauth/authorize?client_id=...
errorstring

The error message if the request was unsuccessful

error_codestring

The error code if the request was unsuccessful

messagestring

Optional message (e.g., for authentication required)

Example: Authentication required. Please login first.
requiresLoginboolean

Whether user needs to login before OAuth flow

statestring

OAuth state parameter for security

Example: eyJvcmdJRCI6IjAxSE...
successboolean

Whether or not the request was successful or not

unverifiedboolean
OAuthFlowResponse
{
"authUrl": "https://github.com/login/oauth/authorize?client_id=...",
"error": "string",
"error_code": "string",
"message": "Authentication required. Please login first.",
"requiresLogin": true,
"state": "eyJvcmdJRCI6IjAxSE...",
"success": true,
"unverified": true
}