Keys

Keys 

The Keys page allows the user to manage API keys for API based access to Akrimanager functionality.

Add Keys

To create keys, follow the below instructions:

1. Click button located on the top right corner of the screen. The Add Keys window opens.
   
   
   Add Keys 
2. Enter the name and description in the respective fields.
3. Enter email address to which key expiry notifications will be sent.
4. Enter the expiration date for the key in dd/mm/yy format.     
   Note: This date can be updated later anytime before expiry of the key.
5. Click on the radio button to choose the role (Admin or User).      
   Note: This is the role which defines the scope of capabilities available to the API key.
6. Click Create to create and save the key into AkriManager.
7. On successful creation of the API key, the following ‘download key’ screen is displayed.
   
   Download Key
   
   
8. The API key is available only in the above screen and not retrievable later and hence ‘Download’ or ‘Copy’ the API key from this screen. 
9. Click icon to close the window and go back to the Keys page.
10. The API key must be filled in ‘X-API-KEY’ http header when invoking any API. Refer to API programmers guide for details.

The following fields are displayed in the Keys page,

Name

The key names are displayed in this column.

To search a particular key,

1. Enter the key name in the field and click Enter on the keyboard.

Key ID

The key IDs are displayed in this column.

To search a particular key,

1. Enter the key ID in the field and click Enter on the keyboard.

Role

The roles of the users are displayed in this column.

1. To search a particular user role,
2. Enter the role of the user in the search field and click Enter on the keyboard.

Status

The active, inactive and expired status of the keys is displayed in this column. To filter and view status of the keys,

1. Click on the drop down arrow and select the filters. A green tick appears after it is selected.

     The keys according to the filters are displayed.

Added On

The dates on which the keys were added are displayed in this column.

Expiry On

The expiry dates of the keys are displayed in this column.

Actions

This column displays options to,

View Details

To view details of a key, follow the below instructions:

1. Clickicon in the Actions column. The details of the key are displayed.
2. Click icon to close the window and go back to the Libraries>Keys page.

Edit Key

To edit a key, follow the below instructions:

1. Clickicon in the Actions column. The Edit Key window opens.
   
   
   Edit Key

    Name, Key ID, Description, and Email are displayed.

2. Enter the expiration date in dd/mm/yyyy format or click on the calendar field to expand the calendar and select the expiration date.
   Note: The expiration date is displayed in red.
3. Click on the radio button to choose the Role (Admin or User).
4. Click on the slide button to change the Status to Active or Inactive.
5. Click on Update to update the information.
6. Click icon to close the window and go back to the Libraries>Keys page.

Delete a Key

To delete a key, follow the below instructions:

1. Clickicon in the Actions column. A window with Delete and Cancel buttons is displayed. 
2. Click Delete to delete the key or Cancel to go back to the Libraries>Keys page.

Inactivate a Key

When a key is in the active state and you want to inactivate it,

1. Clickicon in the Actions column. 
2. Reactivate the key by clicking  icon.