API Tokens

A Nirmata API Token is an access key that is required to login to NCH via NCTL, or to make raw API requests to NCH. The API token is available in the NCH profile.

Generating API Tokens

To generate an API token in NCH:

  1. Go to Settings>Profile. The page displays all the information related to the NCH profile along with the API key.
  2. Click on the Generate API Key button located on the top right corner of the screen. A dialog box appears with a prompt to enter the password.

Note: If an API Key was already generated and the generated token is within the expiry time, the API Key will be automatically fetched within the dialog box.

  1. Next, enter the password set for the NCH profile under the Password section and leave the API Key section empty.

image

  1. Finally, click Generate to generate a new API Key.

Managing API Tokens Settings

A Nirmata Admin User can manage and review the API Token settings as per requirements.

To manage the API Token settings:

  1. Go to Identity & Access -> API Tokens. The Settings page for API Tokens opens.
  2. Manage the generation and usage of API Tokens for users by clicking on the radio button beside the available options.
    a. Clicking the None option will not allow any user to generate and use API Tokens.
    b. Clicking the All users option will allow all users to generate and use API Tokens. Here, click on the radio button beside Token lifetime to set a specific expiry time for an API Token or click on the radio button beside Never expires to ensure that the token lifetime for an API Token never expires.
    c. Clicking the Selected users based on their option will allow picking selected section of users based on their role and ID provider.
    i. Select the Role or ID Provider from the dropdown available beside the option.
    ii. Select the specific role or ID provider from the next dropdown located below.
    iii. Click on the radio button beside Token lifetime to set a specific expiry time for an API Token or click on the radio button beside Never expires to ensure that the token lifetime for an API Token never expires for users of the selected role or ID provider.
    iv. Click on the + button to add multiple roles or ID providers.

image

  1. Click Save.