Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 1.58 KB

Hooks.md

File metadata and controls

39 lines (29 loc) · 1.58 KB
Raw

CIS Notifications

Change Integration Service version 2 features outbound hooks to notify relying parties that the user profile may have changed.

Basic Flow

The basic flow is as follows.

  1. Publisher triggers an authenticated update.
  2. It is written to the Dynamodb table using dynamodb transactions.
  3. An event is generated to a dynamodb stream.
  4. A webhook service iterates through the single sharded/single partition stream in batches of 10 users.
  5. A request payload is generated that contains the following information.
    {
        "operation": update,
        "id": ad|Mozilla-LDAP|dinomcvouch,
        "time": {epoch timestamp},
    }
  1. The webhook service calls auth0 and signs an authenticated JWT for the API Aud: hook.{prod|dev|test}.{sso.allizom.org|sso.mozilla.com}.
  2. The payload is then posted to all configured relying parties. These RPs can choose (strongly recommended) to authenticate the inbound notification using standard JWT verification with the auth0 .well-known metadata.

External consumers for hooks are not currently supported.

Setup in the IAM Account

Required Parameters This service requires ssm parameter store.

Required:

  • auth0 client id: standard client id
  • auth0 client secret: standard client secret
  • api audience: the API aud you set in the auth0 machine to machine auth
  • rp_urls : A comma delimited list of strings of where to POST payloads

The paths for these are configurable using the CIS_SECRET_MANAGER_PATH var. See the ![serverless.yml](serverless_functions/webhook_notifier/serverless.yml serverless.yml) for an example.