Skip to main content

Tenants requests

note

You must be an organization administrator to make tenant requests.

note

The AdminEmailAddress, AdminName, AdminSurname, AdminPassword, and AdminUserKey parameters are always returned as 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

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Tenants(99)

Request headers​

KeyValue
AuthorizationBearer

Response code​

200 OK

Response body​

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

Disabling a tenant​

POST

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Tenants/UiPath.Server.Configuration.OData.SetActive

Request headers​

KeyValue
AuthorizationBearer

Request body​

{
    "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

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk

Request headers​

KeyValue
AuthorizationBearer

Request body​

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

Response code​

200 OK