Documentation Index

Fetch the complete documentation index at: https://docs.safe.security/llms.txt

Use this file to discover all available pages before exploring further.

API Credentials

  • 1 minute(s) read
Prev Next

Introduction

This page allows you to generate and manage your API credentials. SAFE offers a series of REST APIs that allow customers and partners to extend and leverage existing investments in other software and systems by synchronizing and sharing data between the systems. The SAFE REST API allows third-party software and systems to extract information from the SAFE platform. Integration can be accomplished using a series of different technologies depending on your needs and existing infrastructure. SAFE REST API that extracts data from SAFE can add additional context to other Security tools

Generate API Credentials

To generate the SAFE API credentials:

  1. Navigate to Settings > API Credentials.

  2. Click the + Add API Credentials button.

  3. Enter a name for the API.
    API Creds1.png

  4. Enter the expiry duration for the API credentials.

  5. Click the Add button.

  6. The system displays the API username and password. Copy and save the API credentials.

  7. Make sure you copy your API password. You won’t be able to see this password again.
    API Creds 2.png

Set the Maximum API Credential Validity

This setting determines the maximum validity period users can select when creating an API credential.

Note

Only Admins can view or change this setting. It is not available to other user roles.

Set the Maximum Validity

  1. Navigate to Settings > System Setup > Security.

  2. Select a maximum validity period: 30 days, 60 days, 90 days, 180 days, 365 days, or Custom

  3. To specify a different duration, select Custom and enter a value between 1 and 365 days.

  4. Click Save.

Effect on Existing API Credentials

Lowering the maximum validity also affects credentials that have already been issued.

  • If an existing credential expires after the newly configured limit, its expiry is shortened to comply with the new limit as soon as the setting is saved.

  • If the credential has already passed its recalculated expiry date, it stops working immediately and its expiry status is displayed as Expired.

  • Existing credentials are not deleted.

Note

Shortening a credential’s validity cannot be undone. Increasing the maximum validity later does not restore its original expiry date. To provide a longer validity period, issue a new credential.

Delete an API Credential

Click the three-dot options menu for an API and use the delete option to delete the API credentials.

Edit an API Credential

Click the three-dot options menu for an API and use the edit option to chnage the name of the API credentials.