Orchestrator
2022.4
false
Banner background image
Orchestrator API Guide
Last updated Apr 19, 2024

Tenants Requests

Note: You must be a host administrator to make tenant requests.
Note: The AdminEmailAddress, AdminName, AdminSurname, AdminPassword, and AdminUserKey parameters are always returned as null.

Retrieving Active Tenants

The request below enables you to retrieve all the tenants that are enabled. Please note that the response example has been truncated.

GET

{OrchestratorURL}/odata/Tenants?$filter=IsActive eq true

Request headers

Key

Value

Authorization

Bearer

Response code

200 OK

Response body

{
    "@odata.context": "{OrchestratorURL}/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
        }
    ]
}{
    "@odata.context": "{OrchestratorURL}/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
        }
    ]
}

Retrieving a Tenant According to Its Id

The following example enables you to view the details of the tenant with the 99 Id.

GET

{OrchestratorURL}/odata/Tenants(99)

Request headers

Key

Value

Authorization

Bearer

Response code

200 OK

Response body

{
  "@odata.context": "{OrchestratorURL}/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
    }
  }
}{
  "@odata.context": "{OrchestratorURL}/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
    }
  }
}

Disabling a Tenant

POST

{OrchestratorURL}/odata/Tenants/UiPath.Server.Configuration.OData.SetActive

Request headers

Key

Value

Authorization

Bearer

Request body

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

Response code

200 OK

Disabling a Feature

This request disables the Monitoring feature for a tenant with the Id of 4 .
To enable the feature, make a request to the /odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk endpoint, by setting the Monitoring.Enabled parameter to true.

POST

{OrchestratorURL}/odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk

Request headers

Key

Value

Authorization

Bearer

Request body

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

Response code

200 OK

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.