Authentication Mapping at Import
Authentication visibility within our platform is typically limited to the workspace level.
With the exception of the organization workspace, where authentications are visible across workspaces.
Consequently, users must map authentications when importing workflows and projects across workspaces.
Summary
The authentication mapping process can be summarized as follows:
Import | Notes | Manual / API |
---|---|---|
First import into a workspace | Users are required to choose or create an equivalent authentication associated with this import in the workspace. | This must be done through the UI |
Subsequent imports | If a project and its workflows have been previously imported into the selected workspace, the most recently used authentication will be highlighted as "last used" in the UI and preselected | When importing via the API, authentication will resolve to the most recently used authentication for this specific import |
Selection of Authentications
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.
Creating New Authentications:
Users have the option to create a new authentication with the pre-selected required scope if necessary.
This can only be done through the UI.
Custom Service Authentication:
If the imported project or workflow relies on an authentication based on a Custom Service, users will be prompted to:
- Choose or create the required Custom Service
- Create an appropriate authentication based on the selected or created Custom Service
FAQs
What happens during the first import into a workspace?
During the first import into a workspace, users are prompted to choose or create an equivalent authentication associated with that import in the workspace. This can only be done through the UI.
What if a project and its workflows have been imported before in the same workspace?
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.
How are authentications categorized in the UI when selecting one for an import?
Authentications are categorized into two groups:
Related Authentications: These are authentications last used or created in the same workspace for the specific import.
Other Authentications: This category includes a list of authentications matching the required service, but without certainty that they match the required scope. Users should verify the authentication scope.
Can I create a new authentication during the import process?
Yes, users have the option to create a new authentication with the pre-selected required scope if needed. This can be done only through the UI.
What happens if the project/workflow uses an authentication based on a Custom Service?
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.
Can I perform the project import via the API?
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?
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.