Skip to main content

Available resources

UiPath® exposes the following APIs:

  • Orchestrator API
  • Test Manager API
  • Platform Management API Access
    • Audit - retrieving and downloading audit logs in the organization.
    • Licensing - retrieving and allocating licenses.
    • Identity - creating, updating, or deleting accounts, and managing organization settings.
  • Document Understanding API
  • AI Center API
  • Marketplace API
  • Academy API
  • StudioWeb API
  • Context Grounding API Access
  • PIMS
  • Process Mining API access
  • Traces API Access
  • Data Fabric API
  • IXP.ExternalService

This guide is dedicated to resource access within the context of the platform (Platform Management) for the organization. Please refer to the specific product documentation for information about product-based APIs.

note

The Platform Management APIs are undergoing a process of functional enhancement which may cause breaking changes to the endpoints. That is why the current APIs are marked as Preview in our reference documentation.

Audit​

  • GET /audit_/api/auditlogs—Retrieves the audit logs of your organization.
  • GET /audit_/api/auditlogs/download—Downloads the audit logs of your organization.

Group​

  • GET identity_/api/Group/{partitionGlobalId}—Retrieves all local and built-in groups from the specified partition ID (either organization or tenant).
  • GET /identity_/api/Group/{partitionGlobalId}/{groupId}—Retrieves the specified local or built-in group in the specified partition ID.
  • POST /identity_/api/Group—Creates a new local group.
  • PUT /identity_/api/Group/{groupId}—Updates a local group information.
  • DELETE /identity_/api/Group/{partitionGlobalId}—Deletes all local groups from the specified partition ID (either organization or tenant).
  • DELETE /identity_/api/Group/{partitionGlobalId}/{groupId}—Deletes the specified local group.

Robot Account​

  • GET /identity_/api/RobotAccount/{partitionGlobalId}—Retrieves all robot accounts in the specified partition ID (either organization or tenant).
  • GET /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}—Retrieves the specified robot account in the specified partition ID.
  • POST /identity_/api/RobotAccount—Creates a new robot account.
  • PUT /identity_/api/RobotAccount/{robotAccountId}—Updates the specified robot account information.
  • DELETE /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}—Deletes the specified robot account.
  • DELETE /identity_/api/RobotAccount/{partitionGlobalId}—Deletes all robot accounts in the specified partition ID.

Setting​

  • GET /identity_/api/Setting—Retrieves an application settings based on a list of keys for a specific tenant.
  • PUT /identity_/api/Setting—Updates or creates new settings in a specific tenant.

SAML certificates​

  • PUT https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/primary – Upload or update the primary SAML certificate.
  • PUT https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/secondary – Upload or update the secondary SAML certificate.
  • POST https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/switch – Switch the secondary certificate to become the primary certificate.
  • GET https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/certificates – Get the certificate pair for the organization.
  • DELETE https://cloud.uipath.com/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/{certificateId} – Delete a certificate based on its ID.

User​

  • GET /identity_/api/User/{userId}—Retrieves information about the specified user.
  • POST /identity_/api/User/{userId}/changepassword—Updates the password for the specified user.
  • PUT /identity_/api/User/{userId}—Updates the specifid user information.
  • DELETE /identity_/api/User—Deletes all users.
  • DELETE /identity_/api/User/{userId}—Deletes the specified user.

License allocation​

  • GET /lease_/api/account​/{accountId}​/user-license​/group​/{groupId}—Retrieves a list of all available user licenses for creating or editing a group.
  • PUT /lease_/api/account/{accountId}/user-license/group/{groupId}—Allocates or updates a group rule.