Enate Help
What's New in EnateEnate WebsiteEnate AcademyFeedback
English
English
  • Hi, welcome to Enate Help
  • ✨What's New in Enate
  • Work Manager
    • 💻Work Manager
      • User Roles in Work Manager
      • Home Page
        • Bar Chart and Grid
        • Team Bar - Viewing Your Team
          • Team Bar for Team Members
          • Team Bar for Team Leaders
      • Setting Teams and Queues
      • Quickfind
        • Quickfind Searches with Custom Data Fields
        • How Quickfind works - specifics
      • Managing Contacts
        • Adding, Editing and Deleting Contacts
        • Contacts Page
        • Contact Activity Page
        • Contact Tags
        • Contacts Card
      • Emails
        • Composing Emails
        • Canned Texts
        • Email Attachments
        • Saving an Email as a Draft
        • Scheduling Emails
        • Email Inbox View
        • Sent Items View
        • Outbox View
        • Unhandled Emails
          • Creating New Email Routes from Unhandled Emails
          • Viewing Deleted Emails
          • Unhandled Emails Further Specifics
        • Blocked Email Addresses
      • Using Multiple Tabs
      • Focus List
      • Notifications
      • Getting New Work
      • Creating New Work
        • Bulk Create Work Items
        • Creating a Work Item from an Existing Email
      • Work Item Overview
        • Overview of Work Item Types
        • Adding a Note
        • Defects Card and Recording Defects
        • Timeline
        • Files Tab
        • Time Tracking
        • Forecasting for Cases
        • Custom Cards
        • Viewing Recently Accessed Work Items
      • Processing a Ticket
        • The Ticket Screen
        • Processing a Ticket
        • Merging a Ticket into another Ticket/Case/Action
        • Splitting a Ticket
        • Converting a Ticket into a Case
      • Processing a Case
        • The Case Screen
        • Processing a Case
        • Manually Launching An Action
        • Reworking a Case
        • Sub Cases
      • Processing an Action
        • The Action Screen
        • Processing an Action
        • 'Wait for Sub Cases to Complete' Actions
        • 'ABBYY FlexiCapture' Actions
        • 'Document Extraction' Actions
        • 'Peer Review' Actions
        • 'Send Email' and 'Send Email and Wait' Actions
        • 'Trigger External API' Actions
        • Approval Actions
      • Working with Linked Work Items
        • Linking Existing Work Items
        • Creating New Linked Work Items
        • Viewing Linked Work Items
        • Sharing Emails between Linked Work Items
        • Related Group vs Linked Work Items
      • Working Between Teams
      • Assigning / Reassigning / Unassigning Work
      • Feedback Features
      • Reports
        • Team View Report
        • User's Overview Report
        • Sentiment Analysis Report
        • User Insights Report
      • User Availability Insights
        • The Insights Popup
        • Main Insights Page
        • Main Insights Page: Team Leader Features
        • The User Insights Report
      • Advanced Search
      • User Settings
        • Email Signature Optimisation
      • Test Mode
      • Multilingual Support
      • Appendix
        • How to enable spell check in Enate
        • Potential Validation Errors for Bulk Creation of Work Items
        • Search terms ignored - further details
        • System behaviour for Determining Assignee, Owner & Queue for Work Items
        • Screen Resolution Support
  • Builder
    • 🛠️Builder
      • Navigating Builder
      • Service Lines Screen
        • Creating New Ticket Types in a Service Line
        • Creating New Case Types in a Service Line
        • Creating New Action Types in a Service Line
      • Service Matrix Screen
        • Screen Overview
        • Creating and Editing Customers
        • Creating and Editing Contracts
        • Creating and Editing Services
        • Adding new Tickets & Cases
        • Ways to Create Work Items in Work Manager
        • Process Grouping Work Items
      • Ticket Configuration
        • Cloning from existing Ticket settings
        • The Ticket Screen
        • Adding a Ticket Category Row & Settings
        • Configuring Ticket Attributes
        • Setting a Ticket Live
      • Case Configuration
        • Creating a New Case Process
        • Case Screen Overview
        • Case-level Settings - Case Info Tab
        • Adding Actions to a Case
          • Manual Actions
          • Peer Review Actions
          • Send Email Actions
          • Send Email and Wait Actions
          • Start Case Actions
          • Approval Actions
          • Trigger External API Actions
          • IDP Data Extraction Actions
          • ABBYY OCR FlexiCapture Actions
          • Wait for Sub-Cases to Complete Actions
          • Adding Ad-hoc Actions
          • Adding Action Checklists
        • Case Conditionality
          • Case Conditionality - Formatting Examples
          • Conditionality Based on an Action's Checklist
          • Conditionality – Advanced Mode C# Tips
        • Merging Branches in a Case
        • Ending a Case Early
        • Setting a Case Live
      • Email Mailbox Configuration
        • Email Connectors
        • Email Routes
        • Microsoft Office 365 Email Integration with Enate via Graph API model
        • Setting up your Email Infrastucture
          • Inbound Email Setup
          • Outbound Email Setup
        • Incoming Emails - Processing Logic
          • Wildcard Routes for incoming BCC Emails
          • Wildcard Email Routes - Possible Scenarios
          • Subsequent Email Responses - Scenarios
        • Email Processing Modes - Options
        • Email Receipt & Deduplication
        • Dealing with Incoming Out of Office Emails
        • Enate via Graph API model
      • Email Template Configuration
        • Default Email Templates
        • Creating New Email Templates
        • 'Reply Instructions' Email Template - 'Expression of Intent' Instructions
        • Viewing Where Email Templates Are In Use
        • Comparing & Merging Email Templates
        • Canned Response Configuration
      • Custom Data and Custom Card Configuration
        • Creating Custom Data Fields
        • Creating a Custom Card
        • Importing / Exporting Custom Cards
        • Advanced Custom Cards
        • Linking Custom Cards to Cases / Tickets / Actions
        • Quickfind with Custom Data – Configuration and Rules
        • Extension Properties
      • Schedules and Triggers
        • Schedule Setup
          • Creating a Schedule Structure
          • Creating a Schedule
          • Linking a Schedule to a Case
        • Schedule Behaviour for Auto-Launching Cases
        • Triggers
          • Creating a New Trigger
          • Editing an Existing Trigger
          • Viewing Cases Launched by Triggers in Work Manager
      • Shared, Standardised Settings – ‘Flavours’
        • Due Date Flavours
        • Allocation Flavours
        • General Settings Flavours (Action Only)
        • Follow Up Settings
        • Exception Activities – Creating and Cloning New Flavours
      • Case and Ticket Configuration Validation
      • Approval Flows
      • Integrations - Marketplace
      • User Management
        • Service Agents
        • Robots
        • Self Service Users
        • User Groups & Data Permissions
        • User Roles & Feature Access
        • Application Credentials
      • Working Calendar Management
      • Adding Localizations
      • Viewing Deleted Items
      • System-Wide Settings
        • General Settings
        • Defect Parties
        • File Tags
        • Office 365 Integration
        • Suppliers
        • Queues
        • Contact Tags
        • Departments
        • Locations
        • Cost Centers
        • Password Policy
        • SSO Settings
        • Approval Settings
        • Privacy Policy Display
      • Maximum Limits in Enate
      • Useful Links
      • Validation Codes
      • Administration
        • Enate System Setup Requirements / Whitelisting
        • Binary Data Storage Options - 'Bring Your Own Bucket'
        • Files: Anti-Malware Scanning
        • Activities Audited in Enate
        • 2021.1 Engine Descriptions
        • Open Source Components
        • SSO Configuration
  • EnateAI
    • EnateAI
      • EnateAI for Email
        • Enate AI - Email Classification
        • EnateAI - Email Data Extraction
        • Enate AI Sentiment Analysis
        • EnateAI - 'Thank You' Email Evaluation
        • Email Connector-level control over Email Integrations
      • EnateAI - Document Classification
      • EnateAI for IDP - Document Extraction
      • EnateAI - AI Analyst (Beta)
        • AI Prompts
          • Bank File Reconciliation
          • Investment Case Content Creation
          • Credit Card Statement Reconciliation
      • Set Confidence Thresholds for your Integrations
  • Enate BI
    • Enate Data Dictionary
  • Integrations
    • Enate Integration Services powered by SnapLogic
      • SnapLogic Overview
        • Using SnapGPT to help you in SnapLogic
      • iPaaS Patterns
      • Build your Pipeline - Enate Integration Pattern 1
      • Enate Integration Services FAQs
      • Resources and Links
    • Enate Integrations
      • Set Confidence Thresholds for your Integrations
      • Email Connector-level control over Email Integrations
      • Auto-classify emails - Email Classification
      • Auto-populate Custom Cards with Email Info - Email Data Extraction
      • Analyse sentiment in emails - Sentiment Analysis
      • Auto-evaluate 'Thank You' emails -Thank You Email Evaluation
      • Auto-tag email attachments - Document Classification
      • Auto-extract document data - Document Extraction
      • Set up a Bot status monitor in Power Automate
      • Integrate third-party WebApps by Iframe with Enate's Advanced Custom Cards
      • Extract Emails & Attachments to SharePoint with Power Automate
      • Auto-notify other apps of new Cases, Tickets & comms with Enate's Webhooks
      • Auto-populate row data into an Enate Case with UiPath
      • Create a Webform that turns requests into Tickets with Enate's APIs
      • Default Current Date & Time into a Field with Enate's Advanced Custom Cards
      • GPT Providers
      • APIs
        • API Changes
        • API Enums
      • ABBYY FlexiCapture
        • Setting up Enate & ABBYY Integration
        • How ABBYY FlexiCapture Actions Work At Runtime
      • Webhooks
        • How to work with Enate's Webhooks
        • List of Enate's Webhooks
        • API Webhook Subscription
        • Webhook Troubleshooting
      • UiPath
        • Setting Up Enate & UiPath Integration
        • Enate UiPath Activity Libraries
        • Enate & UiPath Orchestrator Synchronization
          • UiPath Synchronization V4
          • UiPath Cloud Synchronization V3
          • UiPath Cloud Synchronization V2
          • General Questions and Issues, Debugging and Troubleshooting
      • UiPath Communications Mining
      • Blue Prism
        • Setting Up Enate & Blue Prism Integration
        • Enate Blue Prism Connectors
      • Automation Anywhere
        • Getting Started with Automation Anywhere
      • Power Automate
      • Advanced Custom Card Code
        • Custom Card Validation
        • Custom Card HTML
        • Custom Card CSS
  • WHITE PAPERS
    • Enate White Papers
  • Implementation
    • Enate Implementations
    • Enate Academy Training Courses
  • 📙Glossary of Enate Terms
  • 💬Feedback
Powered by GitBook
On this page
  • Overview
  • Technical Specifics
  • Bearer Tokens
  • Creating a new Application Credentials Record
  • Generating the Bearer Token - Sample
  • Using the Bearer Token

Was this helpful?

Export as PDF
  1. Builder
  2. Builder
  3. User Management

Application Credentials

PreviousUser Roles & Feature AccessNextWorking Calendar Management

Last updated 1 year ago

Was this helpful?

Overview

The Application Credentials page gives developers a dedicated way to support how their APIs can be given access to the system.

Application Credential records can be created by an individual user logged into Builder. In creating such a record, the logged-in user effectively grants their own user account's access levels to the Application Credential record, to allow third party systems using that record subsequently to act on this user's behalf. However the user may not wish to grant the access which is available to all of the roles they occupy, so as part of the record creation they can specify a subset of roles which this Application Credential would have the power to use.

Using this Application Credential approach for granting API access has some advantages over using standard user accounts:

  • A single set of application credentials can have multiple concurrent sessions active.

  • You can select specific levels of access to grant each set of application credentials, keeping permissions only as expansive as they need to be.

  • Allows a more appropriate support for system-to-system communication.

  • Gives better tracking of which APIs are accessed by third party applications.

Technical Specifics

In technical terms, this feature allows Builder admin users to create sets of credentials, specifically 'OAuth Client Credentials' to access Enate & call APIs. Enate uses OAuth2.0 (Open Authorization) for token-based authentication and authorization. For more information on OAuth2.0, please refer to this link .

The approach is as follows:

  1. An Enate user logs into Builder and creates an application Credential record (a specific 'ClientID & SecretKey' record, which is effectively a username & password).

  2. External to Enate, you must call the Enate OAuth/Token API passing the client id and client secret to obtain a token (specifically a '').

  3. Ensure this Token is included in each API call which is made into the Enate system.

Bearer Tokens

Note that the bearer token will expire if it is not used to make an API call for the length of time set in the 'Idle Session Timeout' setting in the General Settings section of Enate Manager.

If the bearer token does expire, the application credentials can be re-authenticated by using the '/OAuth/Token' Enate API to generate a new bearer token.

Additionally, any changes made to a user's roles (i.e. if a user gets assigned a new role or they are removed from a role) will cause the bearer token to expire.

If a bearer token does expire, the application credentials can be re-authenticated by using the '/OAuth/Token' Enate API to generate a new bearer token. Note that revoked roles will not get assigned to a new bearer token.

Creating a new Application Credentials Record

To support this feature we've added a new section in the User Management section of Builder to help manage different sets of Application Credentials you may wish to create:

The resulting screen will show a list of any existing Application Credentials which the logged-in user created before (Application Credentials created by other users are not displayed), including the roles the role(s) assigned to the user and the expiry date.

To create a new credential record, click on the '+' link, and fill out the details in the resulting popup:

Enter a name for the credential and add an expiration date. Then select the Operational Role you want the credential to have. If you want the credential to access Builder, select a Builder role too. These roles determine the various access options that a user will have access to.

Then click to generate a key. This will create:

  • A Client ID

  • A Secret Key

You should copy these two pieces of data at this point, for use in subsequent steps to create a Bearer Token outside of Enate.

Note: You will only be able to access this secret key once, at this point. Once the pop-up window is closed you will no longer have access to it, and if you have not taken a note and subsequently wish to use this client ID, you would need to generate a new secret key.

Once the Credential record has been generated, it will be saved and stored in the Application Credentials page. You, as the creator of the record, can subsequently edit its name and expiry date and generate a new secret key for it. Credential records can also be deleted if desired.

Generating the Bearer Token - Sample

You should use the copied Client ID and Secret Key as inputs into your third party system, for example the Postman API testing tool. From example above, this would be:

Client ID: eba59171-ac3a-4527-939a-830494c2c5f6

Secret Key: 3@rn0i+0y5jRB8_n

The Third-party system should be making a POST API call to the '/OAuth/Token' Enate API to generate the bearer token.

For the API request, select 'x-www-form-urlencoded' in the body section to pass the three parameters below while making the API call to generate the token.

  • grant_type - client_credentials

  • client_id - 0f6c907b-00f4-4e12-8d75-41454b777533

  • client_secret - TLd55KNez61niSXO

Example:

This generates the Bearer token, which is then used to get authorization for API calls to Enate.

Using the Bearer Token

To make a new API call to Enate, select Type as ‘Bearer Token’ in the Authorization section of the API request, pass your generated bearer token and the request URL for the specific API you're looking for.

The integration approach uses a type of tokens called 'Bearer Tokens' to access the Enate APIs. These Bearer tokens use HTTPS security, and the request is not signed or encrypted: possession of the bearer token is considered authentication. For more about OAuth 2.0 access tokens, refer to this link .

🛠️
https://oauth.net/2/access-tokens/
https://oauth.net/2/
Bearer Token