API key management

Introduction

LMS365 enables Microsoft 365 global admin, SharePoint admin, and LMS admins to generate LMS365 API keys.

This allows for control over individual API keys because it's possible to revoke keys that are employed for a specific use without the risk of breaking critical integrations. Either Read Only or Full Control can be assigned to each key, therefore limiting how a specific API key can be used.

This article covers how to find, generate, manage, edit, and revoke LMS365 API keys.

 

Where to manage API keys

Required role: Microsoft 365 global admin, SharePoint admin, or LMS admin.

APIs are managed centrally from the LMS365 Admin Center > Global Settings > API Key Management.

On the API Key Management page, admins can see all the API keys in the LMS365 solution, generate new API keys, assign permissions, and revoke and edit current API keys.

 

API_management_page_overview

 

Overview of API keys

The following information is provided on the API Key Management page:

  • Name. Admins use the name of the API key to identify relevant keys.

  • API Key. The last 12 digits of the API key is shown here. The API key can be copied from here. 

  • Status. Shows whether the API key is Active or Revoked.

  • Permissions. Displays the level of API key permissions: Read Only or Full Control.

  • Date Created. Displays the date and time the API key was created.

  • Created By. Displays the name of the user who created the API key.

  • Revocation Date. Displays the date and time the API key was revoked.

  • Revoked By. Displays the name of the user who revoked the API key.

 

To search for a specific API key, use the Search field or apply filters by selecting the filter icon in the Created By and/or Revoked By column headings.

 

 

Generate API keys

Required role: Microsoft 365 global admin, SharePoint admin, or LMS admin.

To generate an API key, select Generate API Key. The Generate API Key panel opens.

 

 

On the Generate API Key panel, enter an appropriate Name, copy the API key to the clipboard by selecting the Copy API Key icon (if required), and select the relevant permissions level: Read Only or Full Control.

 

 

An API key with Read Only permissions enables data to be read from your LMS365 solution. It's not possible to update, create, or delete data in your LMS365 tenant using an API key with this permission. Attempting to update, create, or delete data using an API key with Read Only permissions causes the attempt to fail.


An API key with Full Control permissions data to be read, updated, created, and deleted in your LMS365 solution.

 

IMPORTANT   

After the relevant type of access is selected and saved, it's not possible to change it.

 

 

Manage API keys

Required role: Microsoft 365 global admin, SharePoint admin, or LMS admin.

On the API Key Management page, you can edit or revoke API keys. To do this, select the relevant API key and choose the relevant option in the Actions panel.

 

 

To edit an API key:

1. Select Edit API Key. The Edit API Key panel opens.

2. Edit the name of the API key. No other fields can be changed.

3. Save your changes.


To revoke an API key:

This action can't be undone.

When an API key is revoked, all flows and connections that are using this API key, for example those created with Power BI and Power Automate, will stop working.

1. Select Revoke API Key.

2. Read the confirmation message. If you want to proceed, select the checkbox.

3. Select Revoke to revoke the API key or Cancel.

 

Was this article helpful?
0 out of 1 found this helpful

Comments

Article is closed for comments.