Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Managing External Applications

This page contains instructions for system administrators who want to check, add, or edit external applications that can obtain authorization in their environment using OAuth.

📘

Note:

You must be a system administrator to perform the tasks described on this page.

Adding an External Application

To register an external application so that it can use OAuth to access your UiPath resources:

  1. Log in to the tenant host as a system administrator.
  2. Go to Settings > Security.
  3. At the bottom of the page, click External applications. The External Applications page opens.
  4. From the Tenant list, select the tenant to which the external application can authenticate.
    All existing external applications for the selected tenant are listed in the table.
  1. Above the table, on the right, click Add Application.
  2. Fill in the Application Name field.
  3. Select an option for Application Type.
    If you select Confidential application, you receive an app secret at the end, so make sure your application can store it securely. If it can't, select Non-confidential application.
  4. Under Resources, click Add Scopes.
    The Edit Resource panel opens on the right, where you can select the resources to which the application should have access.
  5. From the Resource drop-down list, select the UiPath API that the application can use.
    You can only add scope for one resource at a time. If you want to allow access to multiple resources, repeat this process to add scope for each resource.
  6. On the User Scope(s) tab, select the check boxes for the logical API permissions that you want to grant, as needed.
    Granting permissions under user scope means that the external application can access those resources within a user context and a user with the appropriate permissions must be logged in.
  7. If this is a confidential application, you can switch to the Application Scope(s) tab to also grant application-level permissions for the selected resource, as needed.
    With permissions under application scope, the external application has access to application-wide data for the selected scopes without the need for user interaction.
    Non-confidential applications cannot access application scope.
  8. Click Save.
    The panel closes and the selected resource and scopes are added to the Resources table in the form.
  9. If the external application can accept it, you can add a URL in the Redirect URL field and the authorization response is sent there. The application can then use it to access UiPath resources.
  10. Click Add to create the registration.
    A confirmation message opens. For confidential applications, the confirmation message includes the app secret that the registered external application can use to request authorization. Make sure you save it in a secure location because you cannot see it again.

Changing the Scope for an Existing Application

Scopes are the permissions of the external application in relation to a UiPath resource.

  1. Log in to the tenant host as a system administrator.
  2. Go to Settings > Security.
  3. At the bottom of the page, click External applications. The External Applications page opens.
  4. From the Tenant list, select the tenant where the external application was registered.
    All existing external applications for the selected tenant are listed in the table.
  5. Click EditEdit at the right of the application row.
  6. Change the scope to which the application has access:
    • Use the icons at the right of a resource row to edit existing scope or to delete the resource.
    • Click Add Scopes to add an additional resource and then select scopes for it.
  7. Click Save.

Generating a New App Secret

If you don't know the application secret that was generated for a confidential external application, you cannot recover it. But you can generate a new one.

📘

Note

If you generate a new app secret, make sure to share it with the developer who is maintaining the integration with the external application. They must update the authentication mechanism, otherwise the existing integration no longer works.

To generate a new app secret:

  1. Log in to the tenant host as a system administrator.
  2. Go to Settings > Security.
  3. At the bottom of the page, click External applications. The External Applications page opens.
  4. From the Tenant list, select the tenant where the external application was registered.
    All existing external applications for the selected tenant are listed in the table.
  5. Click EditEdit at the right of the application row.
  6. Under App Secret, click Generate New.
    A new app secret is generated and displayed above the button. It remains visible until you click Cancel to close the page.
  7. Copy the app secret and make sure you store it in a safe place.

Providing Details to Developers

After you register an external application, a developer must also set up the external application so that it properly authenticates, requests authorization from UiPath Identity Server, and then accesses the allowed UiPath resources.

Instructions for the developers maintaining the integration with the external application are available in Accessing UiPath Resources Using External Applications.

For developers to be able to perform those tasks, you must share the following information with them:

  • the Application Type and Application ID, both of which are visible on the External Applications page
  • the scopes added for each scope type; for some resources, the same name is used under both user and application scopes, so the type is also important
  • if this is a confidential application, the application secret generated when you registered the external application.
    If you don't have the secret anymore, generate a new one.

Updated 3 months ago


Managing External Applications


This page contains instructions for system administrators who want to check, add, or edit external applications that can obtain authorization in their environment using OAuth.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.