Mandantenabfragen

API-Anforderungen für die Verwaltung von Mandanten, verfügbar für Organisationsadministratoren

Hinweis:

Sie müssen ein Organisationsadministrator sein, um Mandantenanforderungen zu stellen.

Hinweis:

Die Parameter AdminEmailAddress, AdminName, AdminSurname, AdminPassword und AdminUserKey werden immer als null zurückgegeben.

Abrufen aktiver Mandanten

Das folgende Beispiel zeigt, wie Sie alle aktivierten Mandanten abrufen können. Bitte beachten Sie, dass die Antwort abgeschnitten wurde.

Abrufen

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Tenants?$filter=IsActive eq true

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tenants",
    "@odata.count": 125,
    "value": [{
            "Name": "mynewtenant",
            "AdminEmailAddress": null,
            "AdminName": null,
            "AdminSurname": null,
            "AdminPassword": null,
            "LastLoginTime": "2017-12-04T16:20:58.65Z",
            "IsActive": true,
            "Id": 93,
            "License": null
        },
    {...},
        {
            "Name": "testing_orche",
            "AdminEmailAddress": null,
            "AdminName": null,
            "AdminSurname": null,
            "AdminPassword": null,
            "LastLoginTime": "2018-01-16T03:40:43.073Z",
            "IsActive": true,
            "Id": 100,
            "License": null
        }
    ]
}

Abfragen eines Mandanten nach dessen ID

Im folgenden Beispiel zeigen Sie die Details des Mandanten mit der ID 99 Id an.

Abrufen

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Tenants(99)

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
  "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tenants/$entity",
  "Name": "Documentation",
  "AdminEmailAddress": null,
  "AdminName": null,
  "AdminSurname": null,
  "AdminPassword": null,
  "LastLoginTime": "2018-11-26T11:28:03.56Z",
  "IsActive": true,
  "Id": 99,
  "License": {
    "HostLicenseId": null,
    "CreationTime": "2018-01-12T11:49:48.177Z",
    "Code": "1234567890",
    "Id": 99,
    "Allowed": {
      "Unattended": 99,
      "Attended": 99,
      "NonProduction": 99,
      "Development": 99
    }
  }
}

Deaktivieren eines Mandanten

Posten

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Tenants/UiPath.Server.Configuration.OData.SetActive

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

{
    "tenantIds": [375],
    "active": false
}

Antwortcode

200 OK

Deaktivieren einer Funktion

Diese Anforderung deaktiviert die Überwachungsfunktion für einen Mandanten mit dem Id von 4 .

Um die Funktion zu aktivieren, stellen Sie eine Anforderung an den /odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk -Endpunkt, indem Sie den Parameter Monitoring.Enabled auf true.

Posten

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

{
    "Name": "Monitoring.Enabled",
    "TenantId": [4]
    "Value": False
}

Antwortcode

200 OK