SUMMARY.md

Table of contents

Learn

• Introduction
• Verifiable Credentials
  • What issues will Verifiable Credentials address?
  • What are the key roles in Verifiable Credentials?
  • What are the components of Verifiable Credentials?
  • What are the benefits of Verifiable Credentials?
  • Digital Credentials vs Verifiable Credentials
  • QR code vs Verifiable QR code
  • Use Cases
• Electronic Registries
  • Evolution of Electronic Registries
  • What issues will Electronic Registries address?
  • Benefits of Electronic Registries
  • Registry vs Database
  • Design Principles
  • Use Cases
• Sunbird RC Overview
  • Features
  • Core Registry Verbs
  • Why do we need Sunbird RC?
  • What Sunbird RC is and what it's not? (WIP)
  • Core Capabilities
  • Technical Specification Draft
  • Workflows
  • High level architecture
  • High level architecture
• Sunbird RC in action
  • Implementations (Work in Progress)
  • Possibilities

Use

• Technical Requirements
• Technical Requirements
• Releases
• Setup the Backend
• Setup the Frontend
• Leveraging Existing data stores
• SSO with existing systems
  • Digilocker Meripehchaan SSO

Developer Documentation

• Generic OAuth Configuration

Developer Documentation

• Installation Guide
  • Registry CLI
    • Setup A Registry Instance
  • Manual installation through docker-compose
  • Production setup through Helm
• Introduction To Schemas
• Creating Your Own Schemas
• Schema Configuration
• Using The APIs
• Create Schemas With Custom Password
• Admin Portal
  • Login
  • Get Started
    • Create Schema
    • Attestation Workflows (WIP)
    • VC Template
      • Custom VC Template (WIP)
    • Ownership (WIP)
    • Publish (WIP)
  • Dashboard
• Configuration
• Developer Setup
• VC Verification Module
• Audit Configuration
• Custom Keycloak Build
• Metrics
• Digilocker Integration
• Custom QR Code design
• Notifications Configuration
• View Templates Configuration
• Generic Identity And Access Management
• Backup and Restore
  • PostgreSQL
    • SQL Dump
    • File System Level Backup
    • Continuous Archiving and Point-in-Time Recovery (PITR)
  • Cassandra
    • Snapshot-based backup method
    • Incremental backup method
    • Data Restore
• Frontend Configurations
• Frontend - Proxy configuration

API Reference

• Registry
  • Create An Entity
  • Invite An Entity
  • Generate token
  • Generate admin token
  • Get An Entity
  • Get An Entity By Id
  • Update An Entity
  • Create A Property Of An Entity
  • Update A Property Of An Entity
  • Revoke a Credential
  • Delete An Entity
• Schema
  • Create Schema
  • Get Schema
  • Update Schema
  • Delete Schema
  • Publish A Schema
• Attestation API
  • Raise An Attestation
  • Get Attestation Certificate
• Claims API
  • Get All Claims
  • Get Claim by ID
  • Attest A Claim
• Discovery API
  • Search An Entity
• File Storage API
  • Upload A File
  • Get Uploaded File
  • Delete A File/ Multiple Files
• Bulk Issuance API
  • Get Sample Template
  • Upload CSV
  • Get all uploaded Files
  • Download a Report File
• Metrics APIs
  • Get Count
  • Get Aggregates
• ID Gen APIs
  • Generate ID
  • Create ID Format
• Encryption APIs
  • Encrypt
• Other APIs
  • Sign API
  • Verify API
  • Swagger JSON API
  • Health API

Reference Solutions

• Education
  • Education Ecosystem
    • Installation
  • Education Registries
    • Installation
• Certificate Issuance
  • Installation(WIP)
  • User Guide
• eLocker
  • High Level Diagram
  • Installation (WIP)
    • Frontend Setup E-locker
  • User Guide
• Health Registries
  • Organ Registries
    • Frontend Setup
    • Backend Setup
    • User Guide
• Vaccination Platform
• Skills & Work Credentials
• Govt to Person (G2P)
• Unified Learners Passport (ULP)
  • ULP Capabilities
  • Example Scenario
  • Technical Components (WIP)
  • Demo/Sandbox Links (WIP)
  • Installation Guide (WIP)
    • Frontend Setup
    • Installation through docker-compose
    • Dummy records setup for refrence

Links

• Source Code
• Releases & Changelogs
• Website
• Roadmap
• Reference links
• Design

Community

• Discussion Forum
• Contributing
• Contributors
• Contribution Guidebook
• Code of Conduct
• Community Events
• Status By Track

HELP

• Roadmap
• FAQs
• Glossary