Skip to main content
Last verified: 2024-12-26 This guide explains how to set up a new Veratrace instance.

​
Instance Configuration

An instance requires:
  • id - Instance identifier
  • userPoolId - AWS Cognito User Pool ID (format: region_xxxxxxxx)
  • clientId - Cognito OIDC client ID
  • region - AWS region (extracted from userPoolId)
Source: Feature Inventory - Core Objects (Instance)

​
AWS Cognito Setup

Each instance uses its own AWS Cognito user pool for authentication.

​
Create User Pool

  1. Create an AWS Cognito User Pool
  2. Note the User Pool ID (format: region_xxxxxxxx)
  3. Extract the region from the User Pool ID
Source: /Users/vincentgraham/clearline-ui/src/app/auth/auth.js

​
Create OIDC Client

  1. Create an OIDC client in the User Pool
  2. Note the Client ID
  3. Configure redirect URI (default: http://localhost:5173/ for development)
Source: /Users/vincentgraham/clearline-ui/src/app/auth/auth.js

​
Instance API

Fetch instance configuration: API: GET /instances/:id Response: 
{
  "id": "6d0e296f-24c2-4ea6-989f-394565723291",
  "userPoolId": "us-east-1_xxxxxxxx",
  "clientId": "...",
  "region": "us-east-1"
}
Source: Feature Inventory - API Surface (Instance API)

​
Environment Configuration