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

Try Now

Create IP address whitelists for a user

Purpose

Creates IP address whitelists for a user. An administrator can create 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 is applied to the authenticated user.

URL

https://<myserver>:<port>/api/mgmt/security/whitelist/user
An administrator can create 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

POST

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.

Request Payload Definition

The request takes the following format. The properties of the request are described in the table that follows.
{
"managementAPI": [
{
"startAddress": "<start_ip_address>",
"endAddress": "<end_ip_address>"
}
],
"adminAPI": [...],
"dataAccess": [...],
"webUI": [...]
}
Property
Description
Usage
Valid Values
"managementAPI"
Individual IP addresses or a range of IP addresses that restrict access to the Management API.
Optional
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.
Optional
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.
Optional
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.
Optional
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.

Request Payload Sample

{
"managementAPI": [
{
"startAddress": "10.20.30.0",
"endAddress": "10.20.30.10"
}
],
"adminAPI": [],
"dataAccess": [
{
"startAddress": "10.20.30.0",
"endAddress": "10.20.50.10"
}
],
"webUI": null
}

Sample Server Success Response

Status code: 201
Successful response
{
"managementAPI": [
{
"startAddress": "10.20.30.0",
"endAddress": "10.20.30.10"
}
],
"adminAPI": [],
"dataAccess": [
{
"startAddress": "10.20.30.0",
"endAddress": "10.20.50.10"
}
],
"webUI": null
}

Sample Server Failure Response

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

Authentication

Basic Authentication using Login ID and Password

Authorization

To create 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 create 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