--- title: SAFEQ Cloud - API Configuration description: In this guide, we'll guide you through the process of adding and configuring the Intuitive API user for your SAFEQ Cloud instance --- [Skip to content](https://help.intuitivebusinessintelligence.com/safeq-cloud-api-user-configuration#main-content) English Show submenu for translations ![Intuitive logo RGB-1.png\]](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/Intuitive%20logo%20RGB-1.png?height=40&name=Intuitive%20logo%20RGB-1.png) Open main navigation Close main navigation - English Show submenu for translations - [Go to weareintuitive.com](https://weareintuitive.com/) [Go to weareintuitive.com](https://weareintuitive.com/) Hello. How can we help you? - There are no suggestions because the search field is empty. 1. [Help Center](https://help.intuitivebusinessintelligence.com/?hsLang=en) 2. [Intuitive for SAFEQ Cloud](https://help.intuitivebusinessintelligence.com/intuitive-for-safeq-cloud?hsLang=en) # SAFEQ Cloud - API Configuration ## In this guide, we'll guide you through the process of adding and configuring the Intuitive API user for your SAFEQ Cloud instance ### API User Configuration To get started, we first need to create a new role for the "intuitive-api" user. This role needs to be locked down to a few select permissions, so does not require full admin access. #### Step 1 Log in to your SAFEQ Cloud instance, locate your customer and head to *Users* -\> **Roles** in the main menu system.  Click "Add" ![](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/image-png-Jan-29-2025-02-04-05-7176-PM.png?width=670&height=292&name=image-png-Jan-29-2025-02-04-05-7176-PM.png)   Give the role a name, such as "Intuitive API User", and add the below *view* role permissions: 1. ViewInputPort 2. ViewOutputPort 3. ViewReport 4. ViewAccount 5. ViewUser 6. ViewLocations 7. SearchLocation ![](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/image-png-Jan-29-2025-01-59-03-0142-PM.png?width=670&height=416&name=image-png-Jan-29-2025-01-59-03-0142-PM.png) Then click "Save"   #### Step 2 Next, we need to create the Intuitive account. Head to **Users** in the menu. Click "Add" ![](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/image-png-Jan-29-2025-02-06-40-2552-PM.png?width=670&height=337&name=image-png-Jan-29-2025-02-06-40-2552-PM.png) Fill out the user details for the "intuitive-api" account. An example is provided below: ![](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/image-png-Jan-29-2025-02-07-16-3590-PM.png?width=670&height=537&name=image-png-Jan-29-2025-02-07-16-3590-PM.png)   #### Step 3 Next, we need to apply our Access Control to the new Intuitive account. Head to *Users* -\> **Access control** in the menu. Click "Add" ![](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/image-png-Jan-29-2025-02-09-04-1110-PM.png?width=670&height=292&name=image-png-Jan-29-2025-02-09-04-1110-PM.png) Select the appropriate "Authentication Provider" for the Intuitive account. Select the "Security Role" of "Intuitive API User" In the "User or group name" field, either enter the username for your new Intuitive account and click "Search", or leave the field blank and search for the Intuitive account in the list. Click the new Intuitive account, and ensure it is highlighted. Then click "Save". ![](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/image-png-Jan-29-2025-02-09-45-3032-PM.png?width=670&height=599&name=image-png-Jan-29-2025-02-09-45-3032-PM.png)   #### Step 4 Finally, we need to generate an API key. Head to **Security** in the menu, select API access keys in the banner, then click "Add". ![](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/image-png-Jan-29-2025-02-11-23-2121-PM.png?width=670&height=208&name=image-png-Jan-29-2025-02-11-23-2121-PM.png) Fill out the API key details, and make a note of the API Key value. The required API permissions are listed below: ![](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/image-png-Jan-29-2025-02-12-27-6876-PM.png?width=670&height=687&name=image-png-Jan-29-2025-02-12-27-6876-PM.png) `If "Automatic endpoint trust" is not enabled, you will need to authorise Intuitive's access during the setup in the SAFEQ Cloud interface. However, Intuitive / your partner will be able to inform you of the UUID for you to authorise against.` You can match the same role permissions to the API key for additional security. To do so, click "**Advanced API Permissions**" and give the key the same roles. As a reminder, we've included them below: 1. ViewInputPort 2. ViewOutputPort 3. ViewReport 4. ViewAccount 5. ViewUser 6. ViewLocations 7. SearchLocation ![](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/image-png-Jan-29-2025-01-59-56-3846-PM.png?width=670&height=456&name=image-png-Jan-29-2025-01-59-56-3846-PM.png) With those details in hand, you've now created the required permissions for the Intuitive for SAFEQ Cloud configuration. For the next steps, ensure that you have sent over the username and API key to the required technical partner. Due to the security of the SAFEQ Cloud API, you do not need to inform Intuitive of the account password.   ### Intuitive Configuration Once your Intuitive pod in Azure has been provisioned, with the login details supplied, you're ready to insert the API configuration details you collated in the prior steps into the Intuitive API Connection. We've included below a handy Storylane demonstration for inserting these details, although alternatively you can continue reading this article. Connection Screen - Storylane Demo     To get started, log in to the dashboards, and head to the Main Menu, then Connections, Edit Connection. Open the connection below under: Global -\> SAFEQ    In the resulting screen, we need to supply in the relevant fields the details we obtained from the API User Configuration. ![](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/image-png-May-08-2026-10-48-15-6463-AM.png?width=626&height=342&name=image-png-May-08-2026-10-48-15-6463-AM.png) **SAFEQ Tenant** Supply the URL to the target SAFEQ Cloud instance. This is the same URL you use to sign into SAFEQ Cloud, such as test123.eu.eophcp.com. **API Key** Paste in the API Key value from the SAFEQ Cloud interface. **Authentication Port** Enter the authentication port for your SAFEQ Cloud instance. The default value is **443**. **API Port** Enter the API port for your SAFEQ Cloud instance. The default value is **443**. **Client ID** Enter a unique GUID for your Intuitive configuration. You can check the current Endpoint GUID's in SAFEQ Cloud -\> Infrastructure -\> Endpoints **Username** Paste in the Username value from the SAFEQ interface. **Historical Data** Enter number of historical days to export from SAFEQ. Default value is 730. **Configuration Data** You can leave the default values.   With those values updated, ensure that the connection has been saved. After saving your changes, the connection should then start to pull down the data from SAFEQ Cloud. In the event that it does not, you can trigger this manually by heading to the below location in Intuitive: Main Menu -\> Admin -\> ETL Management   You can kick off a refresh of the feeds by clicking the refresh icon next to the connection of "SAFEQ". An example is listed below, but you can wait for the next refresh interval (120 minutes) instead: ![](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/image-png-Nov-30-2023-03-32-27-1788-PM.png?width=670&height=446&name=image-png-Nov-30-2023-03-32-27-1788-PM.png) Once the feeds have all refreshed (you can refresh their status via the refresh icon in the top left), you are now free to use the Intuitive for SAFEQ Cloud dashboards. To learn more about each of the dashboards, click the QR code in the bottom left of the respective Intuitive for SAFEQ Cloud dashboard to open a YouTube tutorial.   - [Intuitive Dashboards Core Software](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#main-content) - [Getting Started](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#getting-started) - [Viewing Dashboards](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#viewing-dashboards) - [Interacting with dashboards](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#interacting-with-dashboards) - [Filters](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#filters) - [Connections](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#connections) - [Datafeeds](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#datafeeds) - [Datasets](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#datasets) - [Components](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#components) - [Creating Dashboards and Components - Overview](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#creating-dashboards-and-components-overview) - [Creating Components](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#creating-components) - [Creating a Dashboard](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#creating-a-dashboard) - [Administering the System](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#administering-the-system) - [Administering Users](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#administering-users) - [Administering Groups](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#administering-groups) - [Security Filters - V5.2 and earlier](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#security-filters-v5-2-and-earlier) - [Security Filters - V5.3 Onward](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#security-filters-v5-3-onward) - [Embedding Dashboards](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#embedding-dashboards) - [Configuration File](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#configuration-file) - [Installation & Configuration Guide](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#installation-configuration-guide) - [Version History](https://help.intuitivebusinessintelligence.com/intuitive-dashboards-core-software?hsLang=en#version-history) - [Intuitive for PaperCut V2](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-v2?hsLang=en#main-content) - [Installing Intuitive for PaperCut](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-v2?hsLang=en#installing-intuitive-for-papercut) - [Viewing PaperCut Dashboards](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-v2?hsLang=en#viewing-papercut-dashboards) - [Editing PaperCut Dashboards](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-v2?hsLang=en#editing-papercut-dashboards) - [Intuitive for PaperCut Demonstration Videos](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-v2?hsLang=en#intuitive-for-papercut-demonstration-videos) - [Intuitive for PaperCut FAQs](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-v2?hsLang=en#intuitive-for-papercut-faqs) - [Intuitive for PaperCut MF V3](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-mf-v3?hsLang=en#main-content) - [Installing Intuitive for PaperCut Version 3](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-mf-v3?hsLang=en#installing-intuitive-for-papercut-version-3) - [Viewing the dashboards - Intuitive for PaperCut Version 3](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-mf-v3?hsLang=en#viewing-the-dashboards-intuitive-for-papercut-version-3) - [Editing PaperCut Dashboards](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-mf-v3?hsLang=en#editing-papercut-dashboards) - [Intuitive for PaperCut FAQs](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-mf-v3?hsLang=en#intuitive-for-papercut-faqs) - [Intuitive for SAFEQ](https://help.intuitivebusinessintelligence.com/intuitive-for-safeq?hsLang=en#main-content) - [General Help](https://help.intuitivebusinessintelligence.com/intuitive-for-safeq?hsLang=en#general-help) - [Software Installation](https://help.intuitivebusinessintelligence.com/intuitive-for-safeq?hsLang=en#software-installation) - [Solution Expertise](https://help.intuitivebusinessintelligence.com/intuitive-for-safeq?hsLang=en#solution-expertise) - [Intuitive For Managed Print Services (MPS)](https://help.intuitivebusinessintelligence.com/intuitive-for-managed-print-services-mps?hsLang=en#main-content) - [Intuitive for MPS - Overview](https://help.intuitivebusinessintelligence.com/intuitive-for-managed-print-services-mps?hsLang=en#intuitive-for-mps-overview) - [Intuitive for MPS - Installation Steps](https://help.intuitivebusinessintelligence.com/intuitive-for-managed-print-services-mps?hsLang=en#intuitive-for-mps-installation-steps) - [Intuitive for MPS - Import File Layouts](https://help.intuitivebusinessintelligence.com/intuitive-for-managed-print-services-mps?hsLang=en#intuitive-for-mps-import-file-layouts) - [Intuitive For MPS - Loading the Data Warehouse](https://help.intuitivebusinessintelligence.com/intuitive-for-managed-print-services-mps?hsLang=en#intuitive-for-mps-loading-the-data-warehouse) - [Intuitive Cloud Services](https://help.intuitivebusinessintelligence.com/intuitive-cloud-services?hsLang=en) - [Intuitive for PaperCut Hive V1](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-hive-v1?hsLang=en#main-content) - [Viewing the dashboards - Intuitive for PaperCut Hive](https://help.intuitivebusinessintelligence.com/intuitive-for-papercut-hive-v1?hsLang=en#viewing-the-dashboards-intuitive-for-papercut-hive) - [Intuitive for SAFEQ Cloud](https://help.intuitivebusinessintelligence.com/intuitive-for-safeq-cloud?hsLang=en#main-content) - [Intuitive Solution Expertise](https://help.intuitivebusinessintelligence.com/intuitive-for-safeq-cloud?hsLang=en#intuitive-solution-expertise) - [Intuitive Software Provisioning](https://help.intuitivebusinessintelligence.com/intuitive-for-safeq-cloud?hsLang=en#intuitive-software-provisioning) - [Intuitive for Docuware](https://help.intuitivebusinessintelligence.com/intuitive-for-docuware?hsLang=en) - [Intuitive for Print Management](https://help.intuitivebusinessintelligence.com/intuitive-for-print-management?hsLang=en#main-content) - [Solution Knowledge](https://help.intuitivebusinessintelligence.com/intuitive-for-print-management?hsLang=en#solution-knowledge) - [Technical Information](https://help.intuitivebusinessintelligence.com/intuitive-for-print-management?hsLang=en#technical-information) - [Intuitive for e-BRIDGE Global Print](https://help.intuitivebusinessintelligence.com/intuitive-for-e-bridge-global-print?hsLang=en) - [Intuitive for e-FOLLOW Cloud](https://help.intuitivebusinessintelligence.com/intuitive-for-e-follow-cloud?hsLang=en) - [FAQ](https://help.intuitivebusinessintelligence.com/faq?hsLang=en#main-content) - [Connections](https://help.intuitivebusinessintelligence.com/faq?hsLang=en#connections) - [General Enquiries](https://help.intuitivebusinessintelligence.com/faq?hsLang=en#general-enquiries) - [Datafeeds](https://help.intuitivebusinessintelligence.com/faq?hsLang=en#datafeeds) - [Datasets](https://help.intuitivebusinessintelligence.com/faq?hsLang=en#datasets) - [System Compatability](https://help.intuitivebusinessintelligence.com/faq?hsLang=en#system-compatability) - [Software Installation](https://help.intuitivebusinessintelligence.com/faq?hsLang=en#software-installation) [![Chill listening crop-3](https://help.intuitivebusinessintelligence.com/hs-fs/hubfs/Intuitive%20logo%20BLACK.png?width=102&height=24&name=Intuitive%20logo%20BLACK.png "Chill listening crop-3")](https://help.intuitivebusinessintelligence.com?hsLang=en) weareintuitive.com Help Center Copyright © 2026, Intuitive Business Intelligence Limited