Managing API Applications

Document created by user.oxriBaJeN4 Employee on Aug 3, 2018Last modified by user.oxriBaJeN4 Employee on Feb 11, 2019
Version 9Show Document
  • View in full screen mode

This guide describes how administrators responsible for adding and managing the API applications your organization has developed, can add, change, enable, disable, and delete API applications in the Administration Console.

 

Add APIAccessing Your API Applications

 

To access your API Applications:

  1. Log on to the Administration Console.
  2. Click on the Administration toolbar button. A drop down menu is displayed.
  3. Select the Services | API Applications menu item. Any existing API applications are displayed.

 

With your API applications displayed you can:

  • Add an application
  • Edit an application
  • Delete an application

 

Adding an API Application

 

To add an API Application:

  1. Click on the Add API Application button.
  2. Fill in the Details section as outlined below:
    FieldDescription
    Application NameProvide a name for the application that you can easily identify.
    CategorySelect a category for the application from the drop down menu:
    • SIEM Integration: Relates to security information and event management (SIEM), that provides real-time analysis of security alerts generated by the application.
    • MSP Ordering & Provisioning: Assists with provisions for the Managed Service Provider (MSP) Portal, available for select Partners to manage customers.
    • Email / Archiving: The application relates to the messages and files stored in Mimecast.
    • Business Intelligence: The application's infrastructure and tools enable access to and analysis of information to improve and optimize decisions and performance.
    • Process Automation: The application allows automation of business processes.
    • Other: Select this option if the application doesn't fit with any of the other categories.
    DescriptionProvide a description of the application.
  3. Click on the Next button.
  4. Fill in the Settings section as outlined below:
    FieldDescription
    DeveloperAdd the name of the application's developer.
    EmailAdd the email address of the application's developer.
  5. Click on the Next button.
  6. Add API ApplicationReview the information displayed in the Summary page to ensure all details are correct. To fix any errors:
    • Click on the Edit link next to the Details or Settings to return to the relevant page.
    • Make your changes and click on the Next button to proceed to the Summary page again.
  7. When you're ready, click on the Add button. The application's details display in a slide in panel.
    You can create keys for your application 30 minutes after you've successfully created it. See the "Creating Application Keys" section below for full details.
  8. Click on the X to return to the list of API applications.

 

Creating Application Keys

 

Once you’ve created your application, you can create its access and secret keys:

  1. Click on the API Application from the application list.
  2. Click on the Create Keys button. A Create Keys wizard is displayed with the Account tab selected.
  3. Enter the Email Address of your service account.
    You’ll need to know the service account’s domain or cloud password for the next step.
  4. Click on the Next button. The Authentication tab is selected.
  5. Complete the Authentication dialog:
    Field / OptionDescription
    Email AddressThis displays the service account email specified in the Account tab.
    TypeSelect the service account's password type (e.g. domain or cloud).
    PasswordEnter the service account's password.
  6. Click on the Next button. The Verification tab is displayed, and a verification code is sent to you by SMS.
  7. Enter the Code within 15 minutes.
    If the verification code entered is older than 15 minutes or has been used before, the verification fails and a new code must be issued.
  8. Click on the Next button. The Keys tab is displayed with the generated keys hidden by default.
    • Click on the Eye Icon icon to display a key.
    • Click on the Page Icon icon to copy the key to your clipboard.
  9. Click on the Finish button to exit the wizard and return to the application list.

 

Changing an API Application

Editing an App

 

To change an API Application:

  1. Click on the Application to be changed. A slide in panel displays.
  2. Click on the Edit button. The Details settings tab displays by default.
  3. Make any necessary changes. You can click on Settings / Details in the navigation panel to switch between tabs as required.
  4. Click on the Save & Close button. Your changes are applied to the application information displayed.
    Changing settings won't generate a new application key.

Enabling / Disabling an API Application

 

To enable / disable an API Application:

  1. Click on the Application to be enabled / disabled. A slide in panel displays.
  2. Toggle the Enabled setting on / off.

 

Enable APIAlternatively:

  1. Click on the three-dot menu icon in the far right corner of the listed applications. A drop down menu displays.
  2. Click on Enable / Disable from the menu, depending on the application's current setting.
  3. A popup message displays to confirm your selection.

 

Deleting an API Application

 

To delete an API Application:

  1. Click on the Application to be deleted. A slide in panel displays.
  2. Click on the Delete button. A popup box displays to confirm the request.
  3. Click on the Delete button to proceed.

 

Delete APIAlternatively:

  1. Click on the three-dot menu icon in the far right corner of the listed application. A drop down menu is displayed.
  2. Click on Delete.

 

See Also:

 

Attachments

    Outcomes