stack/components/operator/docs/04-Modules/05-Auth.md

:::warning This Module is subject to a user license. :::

Requirements

Formance Auth requires:

• PostgreSQL: See configuration guide here.

Auth Object

:::info You can find all the available parameters in the comprehensive CRD documentation. :::

apiVersion: formance.com/v1beta1
kind: Auth
metadata:
  name: formance-dev
spec:
  stack: formance-dev

Define oAuth2 clients

You can define oAuth2 clients to secure your stack. The Auth will then be able to authenticate the incoming requests and forward them to the right service.

Here, you can replace YOUR_ID and YOUR_SECRET with your own arbitrary string values.

apiVersion: formance.com/v1beta1
kind: AuthClient
metadata:
  name: formance-dev-clients
spec:
  id: YOUR_ID
  secret: YOUR_SECRET
  scopes:
    - ledger:read
    - ledger:write
    - payments:read
    - payments:write
  stack: formance-dev