orchestrator
2021.10
false
UiPath logo, featuring letters U and I in white
OUT OF SUPPORT

Orchestrator User Guide

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Nov 11, 2024

About Identity Server

UiPath Identity Server is a service that offers centralized authentication and access control across UiPath products. Its purpose is to provide a coherent experience and parity of functionality for authentication and some aspects of authorization across all UiPath products and services. For Identity Server, these products and services are considered clients.

With the integration of Identity Server, its clients have a shared onboarding and user management experience. Behind the scenes, authentication is performed via Identity Server, which offers Single Sign-On experience and generates tokens to communicate with other products via APIs. Once a user signs in, Identity Server seamlessly performs the calls when accessing other products or services. The sign-out experience is similar - once a user signs out of one client, Identity Server performs the sign-out calls to all the other clients.

Identity Server also acts as a federation gateway, supporting external identity providers, thus shielding its client applications from details of how to connect to these external providers.

Identity Server offers Authentication as a Service, containing the centralized login logic and workflow for all its integrated applications, making it easier for services to integrate with each other over one standard protocol family: OAuth. It is built in .NET Core 3.1 on top of the IdentityServer4 open-source library, and supports the OpenID Connect and OAuth 2.0 frameworks.

Orchestrator Integration

Orchestrator is fully integrated with Identity Server. For Orchestrator, this integration means that:

  • Logging in to Orchestrator is performed via Identity Server, and not through external identity providers.
  • Orchestrator can consume user access tokens, service to service (S2S) access tokens, and robot access tokens generated by Identity Server.
  • Orchestrator propagates to and reads data from Identity Server. When creating a user or a tenant in Orchestrator, an entry for that user/tenant is automatically created in Identity Server. Robot information and some settings are also propagated to Identity Server. The user login attempts are sent from Identity Server to Orchestrator.

Browser Group Policies

Signing in to your Orchestrator service from the Assistant redirects you to the SSO page. In some browsers, you may be prompted to open UiPath Assistant. This happens due to the Assistant's protocol handler not being added to the browser's group policies.

To prevent this behavior, make sure to follow the next steps, depending on the browser (Chrome/Microsoft Edge):

  1. Open Registry Editor.
  2. Navigate to Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Google\Chrome/ or Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge, depending on the browser you use.
  3. Add a new key and name it AutoLaunchProtocolsFromOrigins.
  4. Double-click (Default) to edit the key.
  5. In the Edit String dialog, in the Value data field, add [{"allowed_origins": ["<https://cloud.uipath.com/"],"protocol":> "com.uipath.robot.oidc"}] and click OK.
    Important: The AutoLaunchProtocolsFromOrigins policy requires Chrome 85 or later.
  6. Close all browser tabs and relaunch the browser.
  7. Verify that your browser applied the new policy by navigating to chrome://policy or edge://policy. The recently added policy should be listed under the Chrome Policies or Microsoft Edge section with the OK status.

Settings

Identity Server's settings can be configured as follows:

  • A series of settings are configured during installation. Read about it here.
  • In-depth configurations specific for your environment are performed within its appsettings.json file.
  • External identity provider specific settings are configured within its Identity Management portal.

    Important: Identity Server is mandatory in an Orchestrator installation or upgrade process. We don't support Orchestrator deployments without it.
  • Orchestrator Integration
  • Browser Group Policies
  • Settings

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.