Instance ManagementUser Account

API Credentials

Overview

The API Client panel in the Profile window allows you to generate an API key (made of the client ID and client secret) to authenticate and get access to the Fynapse API. The API key is, by default, valid for 90 days. The panel also allows to remove a particular API key and replace it with a new one.

Keep in mind that an API key inherits all permissions from the user creating it. That is why system administrators should not create API keys for other users, but each user should do it on their own. It is not recommended to share API keys with other users since all actions done using these keys will be logged for the user who generated them.

The API key generated in Fynapse can also be used for integrating with external tools and systems.

API Client Panel

The API client panel comprises the following elements:

  • The Generate button - use it to generate a new API key, that is a pair made of a client ID and a client secret. You can generate and then use many API keys simultaneously.

    Immediately after the client secret is generated, copy and save it outside of Fynapse since you will not be able to preview it once you leave this panel. The client ID will be visible in the API Keys grid even after closing the panel.

  • The Client ID field - displays the generated client ID that will be also displayed in the API Keys grid below
  • The Client secret field - displays the generated client secret that will disappear once you click the X icon or leave the Profile window. Therefore, copy and save it outside of Fynapse.
  • The Copy button - click it to copy the contents of a field next to which the button is placed to the clipboard
  • The API Keys grid - use it to see a list of all generated API keys. The grid has the following columns:
    • Client ID - a part of an API key and a unique identifier of a particular API user
    • Expiration date - a date until the API key is valid. The API key is, by default, valid for 90 days.
    • Status - the API key status. It can be:
      • Valid - informs that the particular API key is valid
      • Suspended - informs that a user account associated with the specific API key is disabled
      • Expired - informs that the particular API key reached its expiration date and cannot be used anymore
    • Actions - use it to remove a selected API key

Tutorials


You can generate and then use many API keys simultaneously.

Each user should generate their own API key and should not share it with other users. Since the key is uniquely assigned to the user who generates it, and inherits that user’s permissions. Additionally, all actions done using this key will be logged for this user.

  1. Log in to your Fynapse account.
  2. Click the User icon in the upper right-hand corner.
  3. In the API Client panel, click the Generate button. The API key, made of a client ID and a client secret, will be generated.

    Immediately after the client secret is generated, copy and save it outside of Fynapse since you will not be able to preview it once you leave this panel. The client ID will be visible in the API Keys grid even after closing the panel.

  4. Copy both the client ID and the client secret by clicking the dedicated icons next to the fields. Save and store them in a secure place outside of Fynapse.
  5. Use the generated credentials to authenticate and get access to Fynapse API.

The API key you generated is, by default, valid for 90 days. After this time, you need to generate a new API key.

  1. Log in to your Fynapse account.
  2. Click the User icon in the upper right-hand corner.
  3. In the API Keys grid, find the API key you want to remove.
  4. Click the trash bin icon.

    The action cannot be reversed.

  5. Confirm the action by clicking the Delete button. The API key will be removed, and it will be impossible to use it again for authentication. You will not be able to use the Fynapse API until you generate a new API key.