Authentication

You may need to provide authentication when accessing external systems or services (e.g., a CRM). In the Authentication configuration item you can set up and manage your authentications as follows:

Property Description
Name Name of the authentication item.
Organization Unit Organization Unit under which this authentication will be available. 
Description A short description that explains what this authentication is for.
Type

The type of your authentication method. The following authentication methods are currently supported:

  • API Key - A unique code used to identify and authorize your system when connecting to an external service. The key is included with each request to prove that it comes from a trusted source.
  • OAuth 2.0 Client Credentials - A secure, token-based method. Your system uses a client ID and secret to automatically obtain an access token from the external service. The token is then used to perform requests without requiring manual login.
API Key Name

💡 Shown when API Key is selected.

 

The exact API key name that will be sent to the server.

How Sent

💡 Shown when API Key is selected.

 

Select how the key is sent to the server: in the Request Header or as a Query String.

Key Value

💡 Shown when API Key is selected.

 

The actual API key provided by the external service.

Access Token URL

💡 Shown when OAuth 2.0 Client Credentials is selected.

 

The URL provided by the external system (e.g., a CRM) to request an access token.

Client ID

💡 Shown when OAuth 2.0 Client Credentials is selected.

 

The ID assigned to Nimbus when registering with the external system.

Client Secret

💡 Shown when OAuth 2.0 Client Credentials is selected.

 

The secret key assigned to Nimbus by the external system; used together with the Client ID to request a token.

Scope

💡 Shown when OAuth 2.0 Client Credentials is selected.

 

Optional permissions Nimbus requests from the external system.

💡Note that Authentication configuration items cannot be deleted as long as they are in use. In the Authentication list, you can see which authentication items are used by which web request.

Table of Contents