skip to main content
Hybrid Data Pipeline API reference : IP Address Whitelist API : Retrieve IP address whitelists for a user
  

Try Now

Retrieve IP address whitelists for a user

Purpose

Returns IP address whitelists for a user. An administrator can retrieve the IP address whitelists for a given user by appending the URL with the ?user query parameter and specifying a user name. If the ?user query parameter is not used, the IP address whitelists of the authenticated user are returned.

URL

https://<myserver>:<port>/api/mgmt/security/whitelist/user
An administrator can retrieve the IP address whitelists for a given user by appending the URL with the ?user query parameter and specifying a user name. For example:
https://<myserver>:<port>/api/mgmt/security/whitelist/user?user=TestUserA

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <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 Payload Definition

The response takes the following format. The properties of the response are described in the table that follows.
{
"managementAPI": [
{
"startAddress": "<start_ip_address>",
"endAddress": "<end_ip_address>"
}
],
"adminAPI": [...],
"dataAccess": [...],
"webUI": [...]
}
Property
Description
Valid Values
"managementAPI"
Individual IP addresses or a range of IP addresses that restrict access to the Management API.
An array of JSON objects. Each object must be either a single IP address designated with the "startAddress" property, or a range of IP addresses designated with the "startAddress" and "endAddress" properties. IP addresses may be specified in either IPv4 or IPv6.
"adminAPI"
Individual IP addresses or a range of IP addresses that restrict access to the Administrators API.
An array of JSON objects. Each object must be either a single IP address designated with the "startAddress" property, or a range of IP addresses designated with the "startAddress" and "endAddress" properties. IP addresses may be specified in either IPv4 or IPv6.
"dataAccess"
Individual IP addresses or a range of IP addresses that restrict data access through JDBC, ODBC, and OData calls.
An array of JSON objects. Each object must be either a single IP address designated with the "startAddress" property, or a range of IP addresses designated with the "startAddress" and "endAddress" properties. IP addresses may be specified in either IPv4 or IPv6.
"webUI"
Individual IP addresses or a range of IP addresses that restrict access to the Web UI.
Note: Can only be applied at the system level.
An array of JSON objects. Each object must be either a single IP address designated with the "startAddress" property, or a range of IP addresses designated with the "startAddress" and "endAddress" properties. IP addresses may be specified in either IPv4 or IPv6.

Sample Server Success Response

Status code: 200
Successful response
{
"managementAPI": [
{
"startAddress": "10.20.30.0"
}
],
"adminAPI": [],
"dataAccess": [
{
"startAddress": "10.20.30.0",
"endAddress": "10.20.30.20"
}
],
"webUI": null
}

Sample Server Failure Response

{
"error": {
"code": 222207916,
"message": {
"lang": "en-US",
"value": "There is no User with that id: 34."
}
}
}

Authentication

Basic Authentication using Login ID and Password

Authorization

To return the IP address whitelists for the authenticated user, the user must have either set of the following permissions.
*Administrator (12) permission
*MgmtAPI (11) and IPWhiteList (29) permissions
To return the IP address whitelists for a user by passing a user name with the ?user query parameter, the user must have either set of the following permissions.
*Administrator (12) permission
*MgmtAPI (11) permission, IPWhiteList (29) permission, and administrative access on the tenant to which the user belongs