UiPath Automation Cloud

The UiPath Automation Cloud Guide

Check the current status of the Automation Cloud here.

About API Access

The Tenants page enables you to access API specific information for each of your existing Orchestrator services, allowing you to easily find the information required for authenticating to your Automation Cloud-based Orchestrator services via API calls. You can also invalidate the already issued access keys in case you ever need to do so.

πŸ“˜

Note:

You can view the API access information for a service if you have the Organization Owner or Organization Administrator role, or if you are assigned to that service.

Viewing API Access Information

  1. Navigate to Admin > Tenants. The Tenants page is displayed with a list of all existing tenants.
  2. Expand the desired tenant to display the available services.
  3. Click API Access () for the corresponding Orchestrator service. The API Access window is displayed with the following service-specific information:
    • User Key - allows you to generate unique login keys to be used with APIs or with 3rd party applications in order to log in and perform actions on your behalf. This was previously known as your refresh token.
    • Account Logical Name - your unique site URL, (for example cloud.uipath.com/yoursiteURL). Read more about it here.
    • Tenant Name - the tenant's display name.
    • Client Id - specific to the Orchestrator application itself, it is the same for all users and Orchestrator services on a specific platform. For example, all the Orchestrator services on cloud.uipath.com have the same Client Id value.
  4. Click the copycopy button next to each of the above-mentioned API access information to copy its value.

You can use the copied information in the process of consuming your Cloud API.

Revoking API Access Information

  1. Navigate to Admin > Tenants. The Tenants page is displayed with a list of all existing tenants.
  2. Expand the desired tenant to display the available services.
  3. Click API Access () for the corresponding Orchestrator service. The API Access window is displayed.
  4. Click the Revoke Access button. A confirmation window is displayed.
  5. Click the Revoke button to confirm your action. The value of the service's User Key is revoked and the Refresh Tokens Revoked window is displayed.
  6. Close the Refresh Tokens Revoked window.

🚧

Important!

Revoking access cancels all previously assigned user keys, thus breaking all applications that rely on previously assigned user keys. A new user key is automatically generated for the selected service.
You need to communicate the new user key to all the affected applications.

Updated 18 days ago


About API Access


Suggested Edits are limited on API Reference Pages

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