Verfügbare Ressourcen

UiPath® stellt die folgenden APIs bereit:

• Orchestrator-API
• Test Manager API
• Zugriff auf die Plattformverwaltungs-API
  • Prüfung – Abrufen und Herunterladen von Prüfungsprotokollen in der Organisation.
  • Lizenzierung – Abrufen und Zuweisen von Lizenzen.
  • Identität – Erstellen, Aktualisieren oder Löschen von Konten und Verwalten von Organisationseinstellungen.
• Document Understanding-API
• AI Center-API
• Marketplace-API
• UiPath Academy-API
• PIMS
• Process Mining API-Zugriff
• Ablaufverfolgungen API-Zugriff
• Datendienst-API

Dieser Leitfaden befasst sich mit dem Zugriff auf Ressourcen im Rahmen der Plattform (Platform Management) für die Organisation. Informationen über produktbasierte APIs finden Sie in der jeweiligen Produktdokumentation.

Hinweis:

Die Plattformverwaltungs-APIs werden funktionell erweitert, was zu grundlegenden Änderungen an den Endpunkten führen kann. Aus diesem Grund werden die aktuellen APIs in unserer Referenzdokumentation als Vorschau gekennzeichnet.

Audit

• GET /audit_/api/auditlogs – Ruft die Prüfungsprotokolle Ihrer Organisation ab.
• GET /audit_/api/auditlogs/download – Lädt die Prüfungsprotokolle Ihrer Organisation herunter.

„Gruppieren“ (Group)

• GET identity_/api/Group/{partitionGlobalId} – Ruft alle lokalen und integrierten Gruppen von der angegebenen Partitions-ID ab (entweder Organisation oder Mandant).
• GET /identity_/api/Group/{partitionGlobalId}/{groupId} – Ruft die angegebene lokale oder integrierte Gruppe in der angegebenen Partitions-ID ab.
• POST /identity_/api/Group – Erstellt eine neue lokale Gruppe.
• PUT /identity_/api/Group/{groupId} – Aktualisiert die Informationen einer lokalen Gruppe.
• DELETE /identity_/api/Group/{partitionGlobalId} – Löscht alle lokalen Gruppen aus der angegebenen Partitions-ID (entweder Organisation oder Mandant).
• DELETE /identity_/api/Group/{partitionGlobalId}/{groupId} – Löscht die angegebene lokale Gruppe.

Robot-Konto

• GET /identity_/api/RobotAccount/{partitionGlobalId} – Ruft alle Roboterkonten in der angegebenen Partitions-ID ab (entweder Organisation oder Mandant).
• GET /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}– Ruft das angegebene Roboterkonto in der angegebenen Partitions-ID ab.
• POST /identity_/api/RobotAccount – Erstellt ein neues Roboterkonto.
• PUT /identity_/api/RobotAccount/{robotAccountId}– Aktualisiert die angegebenen Roboterkontoinformationen.
• DELETE /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId} – Löscht das angegebene Roboterkonto.
• DELETE /identity_/api/RobotAccount/{partitionGlobalId} – Löscht alle Roboterkonten in der angegebenen Partitions-ID.

Nachrichtenvorlagen

• GET /identity_/api/MessageTemplate – Ruft eine Nachrichtenvorlage mithilfe des angegebenen Filters ab.
• GET /identity_/api/MessageTemplate/{templateId} – Ruft die angegebene Nachrichtenvorlage ab.
• PUT /identity_/api/MessageTemplate/{templateId} – Aktualisiert die angegebene Nachrichtenvorlage.

Einstellung

• GET /identity_/api/Setting : Ruft Anwendungseinstellungen basierend auf einer Liste von Schlüsseln für einen bestimmten Mandanten ab.
• PUT /identity_/api/Setting – Aktualisiert oder erstellt neue Einstellungen in einem bestimmten Mandanten.

SAML-Zertifikate

• PUT https://{yourDomain}/{organizationName}/identity_/api/SamlCertificate/primary – Laden Sie das primäre SAML-Zertifikat hoch oder aktualisieren Sie es.
• PUT https://{yourDomain}/{organizationName}/identity_/api/SamlCertificate/secondary – Laden Sie das sekundäre SAML-Zertifikat hoch oder aktualisieren Sie es.
• POST https://{yourDomain}/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/switch – Wechseln Sie das sekundäre Zertifikat zum primären Zertifikat.
• GET https://{yourDomain}/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/certificates – Rufen Sie das Zertifikatspaar für die Organisation ab.
• DELETE https://{yourDomain}/{organizationName}/identity_/api/SamlCertificate/{partitionGlobalId}/{certificateId} – Löschen Sie ein Zertifikat basierend auf seiner ID.

Benutzer

• GET /identity_/api/User/{userId} – Ruft Informationen über den angegebenen Benutzer ab.
• POST /identity_/api/User/{userId}/changepassword – Aktualisiert das Kennwort für den angegebenen Benutzer.
• PUT /identity_/api/User/{userId} – Aktualisiert die angegebenen Benutzerinformationen.
• DELETE /identity_/api/User – Löscht alle Benutzer.
• DELETE /identity_/api/User/{userId} – Löscht den angegebenen Benutzer.

Lizenzzuteilung

• GET /la/api/account​/{accountId}​/user-license​/group​/{groupId} – Ruft eine Liste aller verfügbaren Benutzerlizenzen zum Erstellen oder Bearbeiten einer Gruppe ab.
• PUT /la/api/account/{accountId}/user-license/group/{groupId} – Weist eine Gruppenregel zu oder aktualisiert sie.

Lizenzressourcenverwaltung

• PUT /lrm/api/host/{hostAccountId}/organization/{organizationId}/license – Weist einer Organisation Lizenzen vom Host zu.
• PUT /lrm/api/account/{accountId}/service-license/{serviceScopeId}/{serviceType} – Weist Lizenzen einem Dienst zu.