orchestrator
latest
false
UiPath logo, featuring letters U and I in white

Anleitung für die Orchestrator-API

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Letzte Aktualisierung 20. Nov. 2024

Benutzerabfragen

Hinweis:
  • GET-Anforderungen an die Endpunkte /odata/Users oder /odata/Users({}) geben eine leere Domäne für AD-Benutzer zurück.
  • Die Anforderungen GetOrganizationUnits(Id) und GetRoles(Id) geben nur Ordner und Rollen zurück, die explizit für einen automatisch bereitgestellten Benutzer festgelegt wurden. Die von der Gruppenkonfiguration übernommen können über den Endpunkt /api/DirectoryService/GetDirectoryPermissions?userId={userId} abgerufen werden.

Löschen eines Benutzers

Löschen

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Users(446)

Anforderungsheader

Schlüssel

Wert

Autorisierung

Inhaber

Antwortcode

204 No content

Ändern der Sprache

Im folgenden Beispiel können Sie die Sprache für den Benutzer mit der 749-ID in Japanisch ändern.

Posten

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Users(749)/UiPath.Server.Configuration.OData.ChangeUserCulture

Anforderungsheader

Schlüssel

Wert

Autorisierung

Inhaber

Anforderungstext

{
    "culture": "ja"
}{
    "culture": "ja"
}

Antwortcode

200 OK

Bereitstellen eines Roboters für einen Benutzer

PUT

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Users(13)

Anforderungsheader

Schlüssel

Wert

Autorisierung

Inhaber

Anforderungstext

{
  "RobotProvision": {
     "UserName": "uipath\\john.smith",
     "RobotId": 53,
     "RobotType": "Development",
     "ExecutionSettings": {}
  }
}{
  "RobotProvision": {
     "UserName": "uipath\\john.smith",
     "RobotId": 53,
     "RobotType": "Development",
     "ExecutionSettings": {}
  }
}

Antwortcode

200 OK

Zuweisen von Rollen

Sie können diesen Endpunkt verwenden, um der angegebenen Benutzer-ID eine oder mehrere Rollen zuzuweisen. Dies kann die ID einer Gruppe, eines Benutzerkontos oder eines Roboterkontos sein.

Posten

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Users(9)/UiPath.Server.Configuration.OData.AssignRoles

Anforderungsheader

Schlüssel

Wert

Autorisierung

Inhaber

Anforderungstext

{
  "roleIds": [
    1,3
  ]
}{
  "roleIds": [
    1,3
  ]
}

Beispiel

Die folgende Anforderung aktualisiert das Konto oder die Gruppe mit der Benutzer-ID 9 , indem die zugewiesenen Rollen mit den Rollen mit den IDs 1 und 3überschrieben werden.

Rollen vor Anforderung

Rollen nach Anforderung

Änderungen

Keine Rollen

1 und 3
Rollen mit den IDs 1 und 3 wurden zugewiesen.
Rollen mit den IDs 1 und 2
1 und 3
Rolle mit ID 2 wurde entfernt und Rolle mit ID 3 zugewiesen.
Rolle mit ID 2
1 und 3
Rolle mit der ID 2 wurde entfernt und Rollen mit den IDs 1 und 3 wurden zugewiesen.

cURL

curl -X POST "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"roleIds\": [ {RoleID1},{RoleID2} ] }"

Swagger-UI (verfügbar unter https://https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/swagger)


Schritt für Schritt

Hier ist ein Beispielverfahren zum Zuweisen von Rollen zu einem Konto:

  1. Stellen Sie eine GET-Anforderung an /odata/Roles, um die Liste der Rollen abzurufen.

    Sie können bei Bedarf jeden Filtertyp verwenden, der von OData unterstützt wird.

  2. Notieren Sie sich die IDs für die Rollen, die Sie zuweisen möchten.
  3. Stellen Sie eine GET-Anforderung an /odata/Users, um die Liste der Konten abzurufen.

    Die Liste enthält Gruppen, Benutzerkonten und Roboterkonten.

    Sie können bei Bedarf jeden Filtertyp verwenden, der von OData unterstützt wird.

  4. Notieren Sie die IDs für die Konten, denen Sie Rollen zuweisen möchten.
  5. Stellen Sie für jedes Konto, dem Sie Rollen zuweisen möchten, eine POST-Anforderung an /odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles .
    • {key} ist eine einzelne Konto-ID für das Konto, dem Sie Rollen zuweisen möchten
    • {roleID} ist eine einzelne Rollen-ID für die Rolle, die Sie zuweisen möchten; Sie können mehrere IDs auflisten, die durch ein Komma getrennt sind.

War diese Seite hilfreich?

Hilfe erhalten
RPA lernen – Automatisierungskurse
UiPath Community-Forum
Uipath Logo White
Vertrauen und Sicherheit
© 2005–2024 UiPath. Alle Rechte vorbehalten