Skip to main content

How to Manage API Settings - For IT Admins

Updated over 3 weeks ago

This article provides instructions on how to manage API settings: enabling API integration, viewing the list of credentials, and revoking API credentials.

What is API Integration?

API Integration is a feature that allows you to perform specific admin operations in LegalOn via an API. By using it, you can integrate with external systems and automate admin tasks.

The following operations can be performed via the API:

  • User settings

  • User group settings

  • Workspace/Folder settings

  • Department settings

Only users with permission to perform the above operations in LegalOn can execute them via API integration. For details on each type of permission, refer to "Understanding Administrator roles, User types, and Access permissions."

Requirements

Plan

  • Enterprise

Access rights

  • IT Admins

Enable API Integration

1. Go to [Admin settings] β†’ [API Integration]

2. Under [Current Status], enable [Allow API Usage].

πŸ’‘ Info:

  • By default, [Allow API Usage] is DISABLED.

  • If there are active API credentials, [Allow API Usage] cannot be DISABLED.

  • For details on how to perform operations via the API, refer to the β€œLegalOn API Developer Portal.”

View the List of API Credentials

You can view the following information for API credentials created via API integration:

  • Owner User Name

  • Status

  • Created Time

  • Last Used Time

  • Expiration Time

You can use [Filter] to narrow down the displayed results.

πŸ’‘ Info:

API credential details cannot be viewed directly from the list screen.

For instructions on how to view the details of each API credential, see β€œHow to Manage API Credentials - For Users.”

Revoke API Credentials

1. Go to [API Integration] to see the API Credentials list screen.

2. Click [...] next to the API credential you want to disable, then select [Revoke].

Related Articles

Did this answer your question?