Banner background image
Marketplace User Guide
Last updated Apr 16, 2024

Authenticate - On Premise Orchestrator With Folder

Before reviewing the example, it's recommended that you first read the How to Authenticate tutorial.

The example below shows the authentication experience when a user selects On-premise Orchestrator as their instance type and enters a Folder value.

How It Works

The following steps and image is an example of how the connector works from design time (i.e., user inputs) to run time (i.e., sending the HTTP request).

  1. Select the Connection type that you want to connect to.

    • The selection determines the Orchestrator API endpoint the connector sends requests to.
    • In this example, On-premise is selected; indicating the endpoint to use is https://{{orchestrator-url}}/api/Account/Authenticate.
  2. Enter a Connection Name.

    • This name is used to identify the connection within your application.
    • A connector can have multiple connections to the same or different Orchestrator tenant. Each connection requires its own connection settings and may include the same or different credentials (i.e., Username and Password). Adding multiple connections to the same tenant is useful if you plan to have multiple users that want to manage their own connections.
  3. Enter your UiPath Orchestrator URL and Tenant Name.
  4. Enter your Email or Username and Password.
  5. Enter a fully qualified Folder name.
  6. Click Connect.

    • Using the Folder input, the connector configures and sends the folowing requests to validate the user has access to the folder:

      • GET https://{{orchestrator-url}}/odata/Folders?$filter=FullyQualifiedName eq ‘{{FolderName}}’
        • Orchestrator API responds with the folder Id.
      • GET https://{{orchestrator-url}}/Users/Users_GetCurrentUser
        • Orchestrator API responds with the user Id.
      • GET https://{{orchestrator-url}}/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key=‘{{folder_Id}}’,includeInherited=true)?$filter=Id eq {{user_Id}
        • Orchestrator API responds with the odata.count (if the user does not have permissions, this value will be 0) and user information.
      • After verifying the user permissions, the connector configures and sends a request with the entered inputs to https://{{orchestrator-url}}/api/Account/Authenticate.
    • The Orchestrator API responds with an access_token that you use for all subsequent API requests.

  • How It Works

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.