How sailpoint-oss/colab-saas-conn-sailpoint-identity-fusion works
Project Type and Purpose
• Type: A Node.js/TypeScript “connector” library (an ISC plugin) that runs as part of the SailPoint CLI/Identity Security Cloud (ISC) ecosystem.
• Purpose: Aggregate account data from multiple sources, generate unique IDs, detect and merge duplicates, and synchronize proxy accounts back to ISC via its REST APIs.
File Structure
Top level:
• .github/ → CI/CD workflows, issue templates
• connector-spec.json → Connector metadata (name, version, commands)
• delete_forms.ps1 → Maintenance script
• assets/images → Documentation screenshots
• src/ → Production code
• test/ → CSV fixtures, HTTP scenarios, Python script
• config files: tsconfig.json, jest.config.js, eslint.config.mjs, package.json, package-lock.json
Inside src/:
• index.ts → Entry point & orchestrator
• axios.ts & sdk-client.ts → HTTP client wrapper for ISC APIs
• contextHelper.ts → Logging, error handling, CLI context
• data/ → Definitions of available actions and statuses
• model/ → TypeScript interfaces for Account, Config, Form, EmailWorkflow, etc.
• utils/ → Utility functions: unique-ID generation, similarity (LIG3), template helpers
README
The README describes the connector’s runtime behavior rather than the code structure:
• Unique ID Generation (Velocity templates, normalization, scope)
• Deduplication workflow (similarity scoring, form generation, reviewer email)
• Mapping & Merging (attribute–identity mapping, multi-valued merges)
• Connector modes (Authoritative vs. Regular)
• ISC integration steps (add connector, configure, run entitlement/account aggregation, reports)
Main Components and Their Interactions
1) “Connector Host”
• SailPoint CLI / ISC runtime environment that invokes the connector
2) Connector Core (index.ts)
• Parses commands (aggregate-accounts, aggregate-entitlements, generate-report, etc.)
• Loads connector-spec.json and user configuration from CLI context
3) Configuration Loader
• Reads and validates “Base”, “Unique ID”, “Merging/Mapping” sections
4) Service Layer
• UniqueIDService: applies Velocity template, normalization, counter logic
• DeduplicationService: computes LIG3 similarity scores, decides if a form is needed
• MergeService: merges multi-valued attributes (first-found, concatenation, multi-valued entitlements)
• ReportService: generates deduplication report, triggers form creation
5) SDK Client (sdk-client.ts + axios.ts)
• Abstraction over ISC REST APIs: GET existing identities/accounts; POST account updates, forms, entitlements
6) Data Models (model/*)
• Strongly-typed payloads for requests/responses: Account, FormInstance, Workflow, Config, Status
7) Utilities (utils/*)
• unique.ts: ID helper, UUID assignment
• lig.ts: similarity function
• index.ts: miscellaneous helpers
8) Tests
• __tests__ use CSV fixtures and HTTP mocks to validate all actions
9) CI/CD
• GitHub workflows in .github/workflows handle build, test, security scans, and deployment via CLI
10) External Systems
• ISC REST API (accounts, entitlements, forms, workflows)
• Reviewers via email (configured in EmailWorkflow model)
Architectural Patterns & Design Principles
• Separation of Concerns – orchestration, configuration, services, HTTP client, utilities
• Command/Action Pattern – each connector command is a discrete action in data/action.ts
• Adapter/Facade – SDK Client wraps raw HTTP calls into typed methods
• Test-Driven Approach – clear boundaries validated by Jest tests and CSV fixtures
Essential Elements
– Component labels, boundaries, and groupings
– CI/CD flow linking GitHub workflows to test & publish steps
– External dependencies: ISC API, email service