Skip to content
HCL Domino REST API Documentation
Domino data with Salesforce
Initializing search
HCL-TECH-SOFTWARE/Domino-rest-api
Welcome
Tutorials
How-to guides
Topic guides
References
HCL Domino REST API Documentation
HCL-TECH-SOFTWARE/Domino-rest-api
Welcome
Tutorials
Tutorials
Quickstart
Installation and configuration
Installation and configuration
System requirements
Docker
Linux
Mac
Win
Post installation tasks
Post installation tasks
Verify connectivity
Securing ports
Enable a database
Configure JWT
Sharing JWT between servers
Configure apps
Setup functional accounts
Capability Walkthrough
Capability Walkthrough
Lab 0 - Overview
Lab 01 - Login to the REST API
Lab 02 - Quick config
Lab 03 - Schema exploration
Lab 04 - Additional scope & schema
Lab 05 - Create an application
Lab 06 - Create a NodeJS application
Lab 07 - Create a SPA
Lab 08 - Create a Java application
Lab 9 - Unlock additional ports
Lab 10 - Configure JWT
Lab 11 - KEEP Configuration
Downloads
ToDo Database tutorial
From Scratch tutorial
Using Admin UI
Using Postman and curl
OpenAPI UI (a.k.a. Swagger)
OData
OData
Access Domino OData in MS-Excel
Domino data with Salesforce
How-to guides
How-to guides
Installation
Installation
Installation and configuration
Create symlink for Domino 14 and Domino REST API
Check Domino REST API settings
Modify configuration of Domino REST API
Deploy to HCL Notes Client
Remove Domino REST API from Domino server or Notes Client
Use WebAuthn (Passkey) to log in to Admin UI
Configure WebAuthn with Domino REST API and Domino 14 or greater
Customize oAuth consent screen
Obtain authentication token from HCL Container Repository
Web
Web
Configure nginx as HTTPS proxy with subdomains
Configure nginx as HTTPS proxy - single domain
IdP
IdP
Configure Domino Rest API IdP
Configure Domino REST API to use an OIDC provider
Configure Azure Active Directory as IdP
Configure certificates
Configure an identity provider
Configure Keycloak
Configure Domino REST API as SAML identity provider
Production
Production
Change file size limit
Configure ports in production
Customize available API schemas and endpoints
Disable and enable module in production
Enable HTTPS using the Domino Certificate Manager
Find configuration sources
Hardened production setup
HTTPS for production
Identify known users with valid JWT token
JWT Multi-Server
Modify configuration parameters
Release suspended users
Set up Office Round Trip Experience
Set up Virtual Spreadsheet
Setup external IdP for Office Round Trip Experience
Set up Domino REST API for encryption, decryption, and signing
Update Domino REST API to the latest release version
Database
Database
Edit database schema JSON
Edit database view of a schema
Enable a database
Enable excluded database files and directories
Export database schema as JSON file
Use external names in schema definitions
Adjust number of retrieved entries when pulling in view data
VoltMX
VoltMX
Configure Domino REST API IdP with Volt MX Foundry Identity Service
Set up oauth.nsf
Code examples
Code examples
JavaScript
JavaScript SDK samples
ReactJS
Topic guides
Topic guides
Introducing the Domino REST API
Understanding HCL Domino REST API
How HCL Domino REST API works
Domino REST API is different
Domino REST API flows
Factories and Caches
Architectural decisions
Planning your application
The Barbican
EventBus
HTTP handler
DominoJNX
Agent processing
Use cases
Domino REST API and Proxy
The shiny web world - a primer
References
References
What's new
System requirements
Installation and configuration
Understanding configuration
Functional accounts
Hosting static applications
OpenAPI
Access control
Using Domino REST API
Using Domino REST API
Domino REST API Applications
Domino REST API CLI
Domino REST API task
Domino REST API roles
DataFormats
Encryption, decryption, and signing
Form and Alias handling
Metrics
Reserved Form mode names
Rich Text
Rich Text
Conversion table
Scopes
Using Domino Console
Logging
Using Web UI
Using Web UI
Schema Management
Scope Management
Quick Config
Application Management
OAuth Consents
Security
Security
Auth\*
JSON Web Token specification
Configuration
Encryption Keys
Set up oauth.nsf
Custom Identity Provider (IdP)
Securing Domino REST API endpoints
User tools
User tools
curl
Postman
Swagger UI
Bruno
Domino REST API SDKs
Configuration parameters
Troubleshooting
Quick reference
Quick reference
Standards
Glossary
Downloads
Admin cheat sheet
Extensions used to open the Microsoft Office in OFBA
Rich Text extension
Deprecated features
Domino data with Salesforce
Domino data can be read/written with Salesforce.
Back to top
