Authentication mapping at import

First and subsequent imports

Copy

Authentication visibility within our platform is typically limited to the workspace level. In most cases, users must map authentications when importing workflows and projects across workspaces.

The table below summarizes authentication selection via UI and API:

Selection of authentications (legacy method)​

Copy

During an import, users will be presented with a list of authentications for the required service, categorized as follows:

• Related Authentications: These are authentications that were either last used or created in the same workspace for this particular import.

• Other Authentications: This category includes a list of authentications matching the required service, although there is no certainty that they match the required scope. It is the user's responsibility to verify that the authentication scope is appropriate.

• Last used: If this is not the first time you are importing the project the last used authentication will be clearly indicated and auto-selected

Selection of authentications (new method)​

Copy

During an import, users will be presented with a list of authentications for the required service, categorized as follows:

• Matching scopes: These are authentications for the same service which are an exact match for scopes

• Different scopes: These are authentications for the same service where there is a scopes mismatch which may give problems and represents a risk to your production environment

• Last used: If this is not the first time you are importing the project the last used authentication will be clearly indicated and auto-selected

If there is a mismatch of scopes for the chosen authentication a warning will be presented:

For Embedded solutions it is particularly important that the scopes for your authentications match.

The scopes of an authentication control the specific level of access that an authentication has, and as explained in our guidance on auth slots when you set the scopes in the source workflow of a solution, this sets the scopes for your End Users.

Therefore if there are mismatched scopes your End Users are likely to experience issues with their Solution Instances.

Please also see our guidance on Breaking changes and Change management (Embedded) for more information.

Creating new authentications​

Copy

You can also choose to create an authentication on the fly. Note that you should take care to match scopes when creating a new auth.

This can only be done through the UI.

FAQs

Copy

Can I perform the project import via the API?​

Copy

Yes. However, the initial project creation or import must be done through the UI to resolve authentication mappings.

Subsequent API imports will rely on the authentication choice established through the UI journey.

How does the API handle authentication choices?​

Copy

The API will resolve the authentication to the most recently used authentication for the specific import.

We recommend importing the project via the UI once to ensure that the correct authentication is memorized for future API imports.

What happens during the first import into a workspace?​

Copy

The first import can only be done through the UI. During the first import into a workspace, users are prompted to choose or create an equivalent authentication associated with that import in the workspace.

What if a project and its workflows have been imported before in the same workspace?​

Copy

For subsequent imports in the same workspace, the recently used authentication will be highlighted as "last used" and preselected. When using the API, the recently used authentication will be used by default.

What happens if the project/workflow uses an authentication based on a Custom Service?​

Copy

If the project/workflow relies on a Custom Service, users will be asked to choose or create the required Custom Service first. Afterward, they can create an appropriate authentication based on the chosen/created Custom Service. This can be done only through the UI.