Skip to content

How-to Guides

Practical, step-by-step recipes for common Verity tasks. Each guide assumes you have a running Verity environment — see Quick Start if you need to set one up first.

Concepts first

If you are new to Verity, read the Concepts section before diving into these guides. Understanding access-decay scoring, review lifecycles, and the connector model will make the steps below much clearer.

Available Guides

  • Build a Custom Connector

    Extend Verity to ingest permissions and audit events from any identity or data platform. Walk through the full connector lifecycle — from scaffolding to production deployment — using the Connector SDK.

    Custom Connector

  • Configure Alerting Rules

    Set up Prometheus alert rules for access-decay score thresholds, SLA violations, and service health. Integrate alerts with Slack, PagerDuty, or Microsoft Teams and route by severity.

    Alerting Rules

  • Set Up SSO Authentication

    Configure Azure AD (Entra ID) as an OIDC identity provider for Verity. Map Azure AD groups to Verity's RBAC roles — admin, reviewer, auditor, and viewer — and verify the end-to-end auth flow.

    SSO Authentication

  • Manage Review Workflows

    Configure the Temporal-powered review pipeline — set SLA thresholds per risk level, define escalation chains, handle delegation and bulk reviews, and integrate with ServiceNow or Jira for ticketing.

    Review Workflows

  • Run Load Tests

    Validate Verity's performance at scale. Use Locust to simulate connector ingestion, API traffic, and concurrent review workflows, then interpret the results against recommended baselines.

    Load Tests

Guide Format

Every guide follows the same structure:

Section Purpose
Goal What you will achieve by the end
Prerequisites Tools, access, and knowledge required
Steps Numbered instructions with code samples
Verify How to confirm the result
Next steps Where to go from here

Prerequisites Checklist

Most guides assume the following baseline:

  • Verity services running (Docker Compose or Kubernetes)
  • Access to the Verity Dashboard at http://localhost:5173
  • API Gateway reachable at http://localhost:8000
  • verity-sdk installed (pip install verity-sdk)
  • Kafka, PostgreSQL/TimescaleDB, ClickHouse, and Redis healthy

Version

These guides target Verity 0.x (current main branch). Specific version requirements are noted where applicable.

Suggest a Guide

Have a task that isn't covered? Open an issue on GitHub with the label documentation and describe the workflow you'd like documented.