Purpose

Deletes IP address whitelists for the authenticated user. An administrator can delete 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 deleted.

URL

https://<myserver>:<port>/api/mgmt/security/whitelist/user

An administrator can delete 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

DELETE

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.

Sample Server Success Response 

Status code: 204
Successful response

Sample Server Failure Response 

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

Authentication

Basic Authentication using Login ID and Password

Authorization

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