Manage Security for the Connect API Explorer

By default, all users are denied access to the Connect API Explorer. System administrators can authorize users to access the Connect API Explorer page.

If a user has been authorized to use the API, only that user can copy their API token. This gives the user access to the application data from outside of Nuix Discover using the Connect API Explorer.

The Connect API Explorer respects the same security settings as the application. If you allow a user to access a certain type of data through the application interface, the user is allowed to access the same data through the API.

For portal administrators, when organization security is enabled, the list of available items depends on membership in a provider or client organization. To understand how organizations are managed in Nuix Discover, see Organizations. For a summary of how organization security affects portal access for each application user category, see Portal Security table.

Grant access to the Connect API Explorer

To allow users to access the Connect API Explorer page:

1. On the Portal Home page, under Portal Management, click User Administration.

2. On the Users page, click a user’s name.

3. In the navigation pane, click API Access.

4. Select the Authorize this user to use the Connect APIcheck box.

   The application generates an API token for the user.

Obtain an API token

If a user has been authorized to use the API, only that user can copy their API token. This gives the user access to the application data from outside of Nuix Discover using the Connect API Explorer. The token authenticates the user.

A user must include their token when they use the API to request data from outside of the application. For example, a user must provide their token when they populate tables in Microsoft Excel with application data. Users do not need to know their token to access the application data using the Connect API Explorer.

To obtain your API token

1. On the Portal Home page, under Portal Management menu, click User Administration.
2. On the Account Settings page, in the navigation pane, click Users.
3. Locate and click your account Name.

   Note

   The API Access page is visible only if a user has been authorized to use the API.
4. Click API Access.
5. Click Copy API token. The token is copied to the clipboard. Paste the token in a text editor.
   Users should store their API token in a secure location, the same way that they protect their password. Anyone who has a user’s token can access all of the data that the user can access through the API.

To obtain a new token for existing users whose account may still have an API key associated with it, or if their API access was revoked:

1. On the Portal Home page, under the Portal Management, click User Administration.
2. On the Account Settings page, in the navigation pane, click Users.
3. Locate and click on the user’s account Name.

   Note

   The API Access page is visible only if a user has been authorized to use the API.
4. Click the API Access page.
5. Clear the Authorize this user to use the Connect API check box.
6. Select this check box again to reactivate their authorization.

Deny access to the Connect API Explorer

You can revoke a user’s access to the Connect API Explorer page.

If you believe that a user’s API token has been compromised, you should revoke the user’s access to the Connect API Explorer page. This revokes the API token. You can then reauthorize the user, and provide them with a new token.

To deny users access to the Connect API Explorer page:

1. On the Portal Home page, under Portal Management, click User Administration.

2. On the Users page, click a name.

3. In the navigation pane, click API Access.

4. Clear the Authorize this user to use the Connect API check box.

   The API token is revoked, and the user is no longer able to access the Connect API Explorer page.