broker-token-rotation.md

Broker at scale

User need

Use this method to rotate/change your broker token for any reason

Flow and Endpoints

Flow

1. Self-enable broker via API
2. Retrieve broker client token
3. Enable Snyk broker permissions in Github Enterprise
4. Setup orgs
5. Set up integrations for each orgs
6. Set up brokers
7. Import projects
8. Figure out when to rotate the token – use rotation & switching API endpoints
   1. Provision a new broker token
   2. Switch to the new broker token
   3. Re-test a project successfully and see logs in the new broker coming through

Endpoints used:

1. Get all org IDs (only group admin)
2. Add new integration
3. Update integration to enable broker
4. Repeat for all other orgs & get broker token for each

Token Rotation tasks:

1. Broker provisioning API
2. Broker token switching
   1. Note: needs admin permissions