User API Keys

• Create an API key
• Revoke an API key

An application programming interface key is a unique identifier used to authenticate access to an API. In order for a user to access the API in order to transfer data out of Curriculum Management, a key needs to be created.  

The API keys can be granted to any Curriculum Management user. In some cases, you may choose to create a user account solely for the purpose of developers or calling programs to facilitate the transfer of data via the API.

Any user can create their own API key, or an admin can create one on their behalf. API keys grant data access and privileges in alignment with the permissions provided to the user. For example, if an admin creates an API key, they're able to access all administrative functions. If a user creates one, they are still only able to access and manage the same content they are able to access when they are working within Curriculum Management.  

API keys are valid for one year from the date they are created. The key will automatically expire on this date, and if the key is still in use, a new key would need to be generated. Admins will be notified of any key that is about to expire, in addition to the user the key is created for.

If you would like to see more information about using the API, you can see the detailed API documentation at developers.Kuali.co.

Create an API Key

• Select the user the key will be created for:
  • If you are an admin creating an API key for a user:
    • Select the App Switcher and then choose the Users app. 
    • 
    • Locate the user you will be assigning the key to. 
  • If you are a user creating an API key for yourself:
    • Under your username in the upper-right corner, select User Settings.
    • 
• Select the tab for API Keys.
  • 
• Click Create Key.
  • 
• Provide a name for the key. Enter a name that has meaning, or possibly indicates the purpose of the key. For example, 'API Key' as a name would not be helpful to someone who is trying to understand why a key was created, or what it is for; but '2023 Key for Program Reports' is. Click Create Key.
  • 
• Once the key is created, it will be displayed on the screen. Copy and save the API key for use. They key will ONLY be shown at this time - there are no options for retrieving a key if it is lost; a new one will need to be generated. 
  • 

Revoke an API key

• Select the user the key will be created for:
  • If you are an admin creating an API key for a user:
    • Select the App Switcher and then choose the Users app. 
    • Locate the user you will be assigning the key to. 
  • If you are a user creating an API key for yourself:
    • Under your username in the upper-right corner, select User Settings.
• Select the tab for API Keys.
• Identify the key to revoke, and click Revoke. Revoking an API key takes immediate effect, and any third-party systems using this key will no longer be able to access the API.