Overview

Use the hosted authorization flow for user sign-in. Use client credentials only for application-owned access to a configured protected resource. Do not collect Raha Account passwords inside client applications.

Endpoint origins

Raha Account deployments may use separate issuer and API origins:

  • ISSUER: discovery, hosted authorization, and account pages.
  • API_BASE: /api/oauth2 protocol endpoints and /api/v1 resource APIs.

Always read the actual URLs from GET {ISSUER}/.well-known/openid-configuration.

Choose a flow

NeedFlow
Sign a user into a web app, SPA, or mobile appAuthorization Code + S256 PKCE
Keep a user signed in with explicit offline consentRefresh token with offline_access
Sign in a TV, CLI, or input-constrained deviceDevice Authorization Grant
Access assigned users from a backend serviceClient Credentials with the account-directory resource
Change the active profile represented by a user tokenToken exchange with a requested profile ID

Core scopes

  • openid enables OpenID Connect and is required for UserInfo.
  • profile, email, and phone release the corresponding approved claims.
  • offline_access requests refresh-token access.
  • users:read, users:read:email, and users:read:phone are application scopes for the account directory.

Next steps

Was this page helpful?