Skip to content

Configure Domino REST API IDP with Volt MX Foundry Identity Service


The KeepManagementURL setting in your notes.ini is the URL needed for the Domino REST API Domino task to talk to the Java side of Domino REST API. By default, this is set to http. If you have updated your security to https, you must update this URL. For more information, see Domino REST API task.

About this task

Domino REST API implements what essentially amounts to an OAuth2 Provider (called IDP-lite) and Volt MX Foundry implements an Integration Service adapter for OAuth2 providers. The following is a guide for creating a Foundry Identity Service using Domino REST API's OAuth provider.

Set up Domino REST API


This is subject to change. Consult Domino REST API documentation (or code, or experts) for the latest steps. Currently, these general steps must be performed:

  1. Deploy oauth.nsf and configure Domino REST API to recognize that file.
  2. Add OAuthAdmin role for the ACL entry that gives your server manager access to the oauth.nsf.

To deploy and configure the NSF, place the following in the domino data directory (you may need to create the keepconfig.d folder if it doesn't already exist):

  • [data folder]/oauth.nsf
  • [data folder]/keepconfig.d/oauth.json

An example of oauth.json is shown below. Expiration times can be adjusted. Make sure to replace the Domino REST API URL to match your Domino REST API host (a fictitious Quickstart Domino REST API url is shown in this example.).

  "oauth": {
    "active": true,
    "database": "oauth.nsf",
    "url": "",
    "authCodeExpiresIn": 120,
    "accessTokenExpiresIn": 3600,
    "refreshTokenExpiresIn": 525600


If you are using Domino+Domino REST API docker image, the oauth.nsf should already be "deployed" in the image but may not be fully configured. If for some reason you need to create oauth.nsf, see Set up oauth.nsf.

Create Foundry Identity Service

Some things to note when creating an identity service in Volt MX Foundry using Domino REST API IDP-lite (also refer to the screenshot below):

  1. Create a new Identity service in the Foundry browser console by filling in the fields:

    • Type of identity = OAuth 2.0
    • Grant Type = Authorization Code
    • Authorize Endpoint = [your Domino REST API API server]/oauth/authorization
    • Token Endpoint = [your Domino REST API API server]/oauth/token
    • IMPORTANT - make sure to select Form Param under Advanced.
    • Take note of the Callback URL.

    Pause here for a moment (don't save yet), and complete the steps for setting up Domino REST API databases and applications.

    • Scope = database name (API Name) for the database added in the next step; if more than one database, you should be able to enter a list of database names; check Domino REST API documentation to see how the names are delimited (perhaps a comma or space, but to Domino REST API it simple, just enter one db name if uncertain about how to specify multiple).
    • Client ID = App id from the application created in the next section below.
    • Client Secret = Obtained when you first create the application (next section).
  2. Now you can Save.

voltmx identityprovider keepidplite

Set up Domino REST API application and database

From the Domino REST API Admin browser client:

  1. Add a database, and note its name (API name, when you create the DB in Domino REST API).
  2. Create an application, and note its client id, and client secret.


When you create the application, you'll need the callback URL defined earlier.

Domino REST API create application

The App id (Client ID) is available any time you view a created application. The secret is shown only when the secret is created the first time. If you forget the secret, generate a new one by clicking the circular arrow as indicated in the following image:

Domino REST API application id and secret