Purpose

Retrieves tenants that are configured with IP address whitelists.

Note: The response returns the tenants that are accessible by the user making the request. If a system administrator (user with Administrator permission) makes the request, the response lists all the tenants in the system that have IP address whitelists. If a tenant administrator makes the request, the response lists only the tenants (with IP address whitelists) for which the tenant administrator has administrative access.

URL

https://<myserver>:<port>/api/admin/security/whitelist/tenants

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

Response Definition

{
  "appliedWhiteLists": [
    {
      "id": tenant_id,
      "name": "tenant_name",
      "protectedResources": [
        "resource_name",
        "resource_name",
        ...
      ]
    },
    ...
  ]
}
Property Description Valid Values
"id" The ID of the tenant. A valid tenant ID.
"name" The name of the tenant A string that specifies the name of the tenant.
"protectedResources" A list of protected resources. One more or more valid protected resources. Protected resources include the managementAPI, adminAPI, dataAccess, or webUI.

Sample Server Success Response

Note: If a system administrator (user with Administrator permission) makes the request, the response lists all the tenants in the system that have IP address whitelists.
Status code: 200
Successful response
{
  "appliedWhiteLists": [
    {
      "id": 1,
      "name": "Tenant1",
      "protectedResources": [
        "managementAPI",
        "dataAccess"
      ]
    },
    {
      "id": 2,
      "name": "Tenant2",
      "protectedResources": [
        "managementAPI"
      ]
    }
  ]
}
Note: If a tenant administrator makes the request, the response lists only the tenants (with IP address whitelists) for which the tenant administrator has administrative access.
Status code: 200
Successful response
{
  "appliedWhiteLists": [
    {
      "id": 48,
      "name": "OrgH",
      "protectedResources": [
        "managementAPI",
        "dataAccess"
      ]
    }
  ]
}

Sample Server Failure Response 

{
  "error": {
    "code": 222208712,
    "message": {
      "lang": "en-US",
      "value": "Problem getting WhiteList IPs at this time. Please try again at another time."
    }
  }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission, or the MgmtAPI (11) and IPWhiteList (29) permissions.