FirebotDocs
Follow us on GitHubJoin our Discord server

OAuth

The OAuth API handles authentication with third-party providers like Twitch, Streamlabs, etc.

GET/auth

Trigger auth provider flow

Redirects the user to the authorization URI of the specified authentication provider. (e.g., Google OAuth2 authorization page).

Optional Query Params

  • Name
    providerId
    Type
    string
    Description

    The ID of the authentication provider.

Request

GET
/auth
curl -G http://localhost:7472/api/v1/auth \
  -d providerId=google

Response

HTTP/1.1 302 Found
Location: https://accounts.google.com/o/oauth2/auth?client_id=...&redirect_uri=...&response_type=code&scope=...
GET/auth/callback2

Callback endpoint

Callback endpoint for authentication providers after user authorization. It exchanges the authorization code or token for an access token.

Optional Query Params

  • Name
    state
    Type
    string
    Description

    The provider ID passed in the initial authentication request, used to identify the provider.

Request

GET
/auth/callback2
curl -G http://localhost:7472/api/v1/auth/callback2 \
  -d state=google \
  -d code=authorizationCodeHere

Response

GET
/auth/callback2
HTTP/1.1 302 Found
Location: https://accounts.google.com/o/oauth2/auth?client_id=...&redirect_uri=...&response_type=code&scope=...