Managing API Key Management

This page explains in detail the process for generating a token using the API key management feature. The resulting token can then be used to execute various API calls across the SSD platform.

API Overview

The API requirements for this process are given below:

• Endpoint: https://<SSD-TENANT-URL>/gate/tokens/usertokenkens/usertoken

• Method: GET

• Authentication: API Key (To be generated from SSD UI)

• Output: User Token (JWT)

Prerequisites

To generate a token, ensure the following requirements are met:

• A valid OpsMx API key (generated from the SSD UI)

• Network access to OpsMx services

• curl installed on the system

To Generate the API Key from SSD

The API key essentially overloads the existing role concept within their RBAC system. Creating an API key generates a unique role associated with the selected teams and permissions. This role is then used in the token generation process, ensuring the token inherits the appropriate access permissions defined by the associated teams and roles.

• Navigate to Setup > API Key Management. The API Key Management page appears.

1. Click Add API Key.

1. In the expanded section, enter the values for the following fields:

2. Name - Enter a name for the API key.

3. Team - Select the team to which you want this API key to be created for.

4. Permission - Select the permission type (Read, Write, Admin) for the API key.

5. Expires In - Select the time limit till which you want the API key to be valid.

6. Click Create.

The API key is generate in the form page, and a confirmation message is displayed as given: API Key Created successfully!

Save this API key securely for subsequent use in the curl command to generate the access token.

To Edit the API Key

The API key details can be updated. To edit the details of the API key,

• Click three dots in the Actions column corresponding to the required API key.

• Click Edit.

• Update the API key's Name, associated Teams, and Permission levels (read, write, or admin) as needed.

• Click Update.

To Regenerate the API Key

The API key details can be regenerated. To regenerate the details of the API key,

• Click three dots in the Actions column corresponding to the required API key.

• Click Regenerate. This option enables the user to create a new API key instantly, typically used when the existing key is lost.

To Delete the API Key

The API key details can be deleted. To delete the API key,

• Click three dots in the Actions column corresponding to the required API key.

• Click Delete. The created API key is removed.

To Obtain API Token using Curl Command

1. Obtain API key from SSD (Steps are mentioned above).

2. Store API key securely.

3. Execute the following curl command.

curl --location 'https://<SSD-TENANT-URL>/gate/tokens/usertokenkens/usertoken' --header 'X-OpsMx-ApiKey: <API_KEY>'

1. Save the returned token.

"eyJhbGciOiJSUzI1NiIsImtpZCI6IjAwMjRkOTRlLTRmZjgtNDgxOC1iM2UyLTUwODNiMTQ5MGFlNiIsInR5cCI6IkpXVCJ9.eyJpc3iOiJPcHNNeCIsImF1ZCI6WyJzc2Qub3BzbXguaW8iXSwiZXhwIjoxNzY2MTMzMjYxLCJuYmYiOjE3NjYw.."