API Access

Owned by Matthew Sywulak
Last updated: Jun 02, 2022 by Rob G (Unlicensed)
3 min read

 

Summary

Customers who use Microsoft 365 or Google Workspace as their mail infrastructure can enable domain and directory access, and remediation API access in INKY. This allows administrators to quickly add new domains to their INKY account and remove one or multiple messages directly from a user’s mailbox.

Granting API access requires a Microsoft 365 Global Admin or a Google Super Admin account. INKY will not remove any messages automatically; only an authorized administrator can invoke the remediation actions.

Domain and Directory Access

To enable this feature, sign in to your INKY Dashboard and navigate to Settings > API Access.

Microsoft 365

Select the Grant Domain and Directory Access button under the Microsoft Graph API Access tab.

Your browser will redirect you to Microsoft to sign in and grant the necessary permissions. If this step is completed successfully you’ll see “Access Granted” under Domain and Directory Access as shown below.

Google Workspace

  1. Navigate to the Google Workspace - Domain Wide Delegation Console.

  2. Select Add New and enter the following information:

    1. Client ID: 102036946623295318758

    2. Scopes: https://www.googleapis.com/auth/admin.directory.user.readonly, https://www.googleapis.com/auth/admin.directory.domain.readonly

  3. Select Authorize

  4. Navigate to Settings > API Access > Google API Access in your INKY Dashboard

  5. Select the Verify Domain and Directory Access button. To verify this, you’ll need to be logged into INKY as the Google Admin.

 

Administrators can now add domains to their INKY Dashboard under Settings > Routing. For more information, please see this article.

Remediation

To enable this feature, sign in to your INKY Dashboard and navigate to Settings > API Access.

Microsoft 365

Select the Grant Remediation Access button under the Microsoft Graph API Access tab.

Your browser will redirect you to Microsoft to sign in and grant the necessary permissions. If this step is completed successfully you’ll see “Access Granted” under Remediation Access as shown below.

Google Workspace

  1. Navigate to the Google Workspace - Domain Wide Delegation Console.

  2. Select Add New and enter the following information:

    1. Client ID: 116106903419769312436

    2. Scopes: https://www.googleapis.com/auth/gmail.modify

  3. Select Authorize

  4. Navigate to Settings > API Access > Google API Access in your INKY Dashboard

  5. Select the Verify Remediation Access option

Administrators can remediate messages from the observations tab and within a custom dashboard under visualizations. For more information, please see the “Routing | Add-a-Domain” article linked below.

Related Articles