- Release Notes
- Overview
- Getting Started
- Marketplace Vendors
- Marketplace Customers
- Publishing Guidelines
- Publishing Guidelines for Ready-to-go Automations
- Publishing Guidelines for Solution Accelerators
- Publishing Guidelines for Integration Service Connectors
- Security & IP Protection
- Other UiPath Listings
- Node-RED
- Setup
- Teams
- Microsoft Teams Scope
- Create Team
- Create Team From Group
- Get Team
- Get Teams
- Channels
- Create Channel
- Delete Channel
- Get Channel
- Get Channels
- Update Channel
- Chats
- Get Chat
- Get Chats
- Get Chat Members
- Messages
- Get Message
- Get Messages
- Get Message Replies
- Reply To Message
- Send Message
- Events
- Create Event
- Delete Event
- Get Event
- Get Events
- Users
- Get User Presence
- How It Works
- Technical References
- Get Started
- About
- Setup
- Technical References
- Azure Form Recognizer Scope
- Activities
- Analyze Form
- Analyze Form Async
- Get Analyze Form Result
- Analyze Receipt
- Analyze Receipt Async
- Get Analyze Receipt Result
- Analyze Layout
- Analyze Layout Async
- Get Analyze Layout Result
- Train Model
- Get Models
- Get Model Keys
- Get Model Info
- Delete Model
- Connectors
- Overview
- Authenticate - Cloud Orchestrator
- Authenticate - On-premise Orchestrator
- Authenticate - On Premise Orchestrator With Folder
- Start a Job - All
- Start a Job - Specific
- Start a Job - JobsCount
- References
- How to Create Activities
- Build Your Integration
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.
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).
-
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.
-
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.
- Enter your UiPath Orchestrator URL and Tenant Name.
- Enter your Email or Username and Password.
- Enter a fully qualified Folder name.
-
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.
- Orchestrator API responds with the folder
-
GET
https://{{orchestrator-url}}/Users/Users_GetCurrentUser- Orchestrator API responds with the user
Id.
- Orchestrator API responds with the user
-
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.
- Orchestrator API responds with the
- 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_tokenthat you use for all subsequent API requests.
-
