Skip to main content
An Organization Administrator registers external applications in UiPath. The application needs the Platform Management and Orchestrator application scopes listed. If the Scopes field asks for a scope the application does not have, UiPath refuses the token.

Find your Cloud Type

The Cloud Type is the UiPath cloud your organization signs in to.

  • Look at the address in your browser when you are signed in to UiPath.
  • cloud.uipath.com is Automation Cloud
  • govcloud.uipath.us is Automation Cloud Public Sector
  • {name}.dedicated.uipath.com is Automation Cloud Dedicated
  • Leaving Cloud Type empty uses Automation Cloud.
  • Select the matching Cloud Type.

Find your Dedicated Cloud Name

The Dedicated Cloud Name is the first part of your Automation Cloud Dedicated address. Skip it for the other clouds.

  • Format: {name} from {name}.dedicated.uipath.com
  • Example: acme
  • Use letters, digits and hyphens only.
  • Copy the Dedicated Cloud Name across.

Find your Organization Name

The Organization Name is your organization’s URL name. In Admin, open Settings. On the General tab, the URL field shows it after https://cloud.uipath.com/.

  • It is not the Organization name field above it, which is a display name.
  • Format: https://cloud.uipath.com/{organization}/{tenant}
  • Example: https://cloud.uipath.com/acmecorp/DefaultTenant gives acmecorp
  • Copy the Organization Name across.
The Admin Settings General tab with the organization URL field highlighted

Find your Tenant Name

The Tenant Name is the Orchestrator tenant the actions run in. In Admin, your tenants are listed under Tenants in the left panel.

  • Format: https://cloud.uipath.com/{organization}/{tenant}/orchestrator_
  • Example: https://cloud.uipath.com/acmecorp/DefaultTenant/orchestrator_ gives DefaultTenant
  • Copy the Tenant Name across.
The UiPath Administration left panel with the DefaultTenant tenant highlighted under Tenants

Find your Organization ID

The Organization ID is the ID UiPath calls the partitionGlobalId. It is a GUID.

1

Check the sign-in address

Sign in to UiPath and look at the address you land on. It holds organizationId= followed by the ID.

  • Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  • The address can change too fast to read.
  • Copy the Organization ID across.
2

Find it with the browser developer tools

Open the developer tools before you sign in, switch to the Network tab and turn on recording.

  • Sign in to UiPath Automation Cloud and select your tenant.
  • After the page loads, find a request such as the Settings API request.
  • Copy the ID that follows partitionGlobalId in its Request URL.
  • Copy the Organization ID across.

Register the external application

An external application is a confidential app that signs in as itself, with no user, using the scopes you give it.

1

Open External applications

Sign in to your UiPath Automation Cloud account as an Organization Administrator.

  • On Automation Cloud Public Sector or Dedicated, sign in at govcloud.uipath.us or {name}.dedicated.uipath.com instead.
  • Open the product launcher at the top left and select Admin.
  • Select the External applications tile.
The Admin home page with the External applications tile highlighted
2

Start a new application

On the OAuth apps tab, click Add application.

The External applications page with the Add application button highlighted
3

Name the application

Fill in the top of the form.

  • Application name: StackOne Integration
  • Application type: Confidential application
  • Leave Access token lifetime (seconds) empty to keep the default of 3600 seconds.
The Add application form with Application name and Confidential application highlighted

Add the application scopes

The application needs scopes from two resources, Platform Management for users, groups and roles, and Orchestrator for jobs, queues, assets and tasks. Add them before you create the application.

1

Open the scope panel

Under Resources, click Add scopes. The Add resource panel opens.

The Resources section of the Add application form with the Add scopes button highlighted
2

Add the Platform Management scopes

Enables actions: Create Group, Create Robot Account, Create User, Get Group, Get Robot Account, Get Unified Group, Get Unified User, Get User, List Groups, List Robot Accounts, List Unified Groups, List Unified Users, List Users, Search Directory

In Resource, select Platform Management.

  • Open the Application scope(s) tab.
  • Tick each scope listed.
  • Click Save.
The Add resource panel with Platform Management selected and application scopes ticked
3

Choose the Orchestrator resource

Under Resources, click Add scopes again.

  • In Resource, select Orchestrator.
  • Open the Application scope(s) tab.
The Resource list in the Add resource panel with Orchestrator highlighted
4

Select the Orchestrator read scopes

Enables actions: Get Folder, Get Machine, Get Package Arguments, Get Process, Get Robot, List Folders, List Machines, List Package Versions, List Packages, List Processes, List Robot Logs, List Robots, List Sessions

Type .Read in Search to shorten the list.

  • Tick each scope listed.
  • Leave the other .Read scopes unticked.
The Orchestrator application scopes filtered to read scopes, with five scopes ticked
5

Select the Orchestrator full-access scopes

These scopes read and change jobs, triggers, queues, assets, Action Center tasks, folders, processes and packages, machines, robots and storage buckets.

  • Tick OR.Jobs, OR.Queues, OR.Assets, OR.Tasks, OR.Folders, OR.Execution, OR.Machines, OR.Robots and OR.Buckets.
  • Type each name in Search and tick the entry with no .Read or .Write ending.
  • When all are ticked, click Save.
The Orchestrator application scopes filtered to OR.Jobs, with OR.Jobs ticked and OR.Jobs.Read and OR.Jobs.Write unticked

Create the application

Create the application, then copy its credentials.

1

Add the application

Check that Resources lists Platform Management and Orchestrator with their application scopes.

  • Leave Redirect URL empty. Application scopes don’t use it.
  • Click Add.
The Resources table listing Platform Management and Orchestrator, with the Add button highlighted
2

Copy the credentials

The Application successfully added dialog shows the App ID and App secret.

  • Copy the App ID across to Application ID.
  • Copy the App secret across to Application Secret.
  • The App secret is shown only once and cannot be viewed again.
The Application successfully added dialog with the Copy buttons for App ID and App secret highlighted

Choose the Scopes

The Scopes field lists the scopes StackOne asks UiPath for, separated by spaces.

  • Example: PM.Group.Read PM.RobotAccount.Read PM.User.Read PM.Group.Write PM.RobotAccount.Write PM.User.Write PM.Directory OR.Folders OR.Execution OR.Jobs OR.Queues OR.Assets OR.Robots OR.Machines OR.Monitoring.Read OR.Tasks OR.Buckets
  • Leaving it empty requests PM.Group.Read PM.RobotAccount.Read PM.User.Read only, which the Orchestrator actions can’t use.
  • Every scope you list must be an application scope on the external application.
  • Leave out the scopes of actions you don’t use.

Directory users

Directory users are accounts from a directory linked to UiPath, such as Microsoft Entra ID. They appear in the user list only when UiPath has turned on directory users in the user list API for your organization.

  • To turn it on, ask UiPath support to enable EnableDirectoryUsersInUserListApi.
  • Until then, the user list fails with a message that says so if your groups or role assignments show directory users.
  • Directory users who are in no group and hold no role are left out, with no error.

Expiry, rotation and revoking

The access token lasts one hour by default. UiPath documents no expiry for the app secret.

  • To replace a lost secret, open Admin > External applications, click Edit on the application, then click Generate secret under App secrets.
  • Copy the new App secret across to Application Secret.
  • To revoke access, click Delete next to each secret under App secrets. UiPath then issues no new access tokens to the application.
The Edit application page with the Generate secret button and a secret's Delete button highlighted
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Next Steps

Webhooks setup

Configure receiving Events for UiPath into StackOne.