Skip to main content

Before you start

Three things decide what an AI app can do for you: your role, the customer's AI access, and the permissions you approve when you connect.

Your account​

You need an admin portal account in the environment you connect to; you sign in with it exactly as in the portal.

Your rights​

RightWhat it gives
Use AI Configuration AccessConnect an AI app at all. No role has it by default; your partner administrator adds it under Partner > Roles.
Manage Customer ConfigChange a configuration. Without it the AI app can only read and test.

You see the same customers as in the admin portal, limited to the customers that allow AI access.

The customer's AI access​

A customer is visible to AI apps only after it has signed the AI access consent form and a Nuntiq global administrator has set its AI access in the customer edit dialog. The customer picks a level for each of four groups:

GroupWhat it covers
ConfigurationReceiving inboxes, capture templates and rules, supplier capture instructions, enrichment and validation rules, rule sets, workflows, scheduler tasks, inbound file formats, email and PDF templates, connectors and integration rules, list views, reason codes, tenant settings (except the session settings), the implementation steps, the testers and the Change History.
Master dataOrganizations, suppliers (locations, addresses, bank accounts) and data tables.
Users and accessCustomer users, user groups, processing teams, single sign-on, API users, supplier integration access, webhooks and the session settings (idle timeout, maximum session lifetime).
OperationsRun a scheduler task now, the run history and connector output, maintenance windows and weekly schedules, test emails and CDN files.

Each group is:

  • Off (default): the AI app cannot use it;
  • Read only: list, read, test and export;
  • Read and write: also change, after you approve.

A customer with every group Off is not visible at all. The AI app gets the same answer for a customer that does not exist, is not assigned to you, or has not enabled AI access. Ask the AI app which customers you can configure once you are connected.

The permissions you approve​

When you connect, the Connect an AI app page in the admin portal lists what the app asks for. Each permission your role allows is ticked; untick what you do not want to give.

PermissionWhat it allows
Read the configuration of your customers, test rules and export configurationAll reading and testing. Required for any connection.
Change the configuration of your customers through reviewed change setsPropose and apply change sets, and the changes on the user, webhook and other pages after you confirm them.
Import Excel sheets (organizations, suppliers, data tables, users, groups, teams, rule sets)Excel imports, after you confirm each one.

A permission your role does not allow is shown greyed out with Your role does not allow this.

In OAuth terms these are the scopes config:read, config:write and config:import. An app that asks for no scopes gets the first two.

How the three combine​

A call succeeds only when all three allow it. For example, a change to a validation rule needs Manage Customer Config on your role, the change permission on your connection, and Read and write for the customer's Configuration group.