Update Authorized Users

Purpose

Update the list of authorized users for an On-Premises Connector. The list of authorized users specified replaces the current access control list of the specified On-Premises Connector.

URL

https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/authuser

Method

PUT

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.

<connector-ID> is a unique value associated with the On-Premises Connector. The value is returned using the <base>/connectors GET request. The authorized user must be the owner of the On-Premises Connector specified.

Request Payload Parameters

The request payload specifies the list of Hybrid Data Pipeline users to add as authorized users. The request has the following format:

{    "authUser":[
      <authorized-user>,
      <authorized-user>,
      …
      <authorized-user>,
   ]
}

Response Definition

If the Update Authorized User operation requested is successful, the response is a JSON object defined as:

{
   "success":true
} 

If the Update Authorized User operation is not successful, the response is a standard error response.

Sample Success Response

{"success":true} 

Authentication

Basic Authentication using Login ID and Password.

Authorization

Any active Hybrid Data Pipeline user. The authenticated user must be the owner of the On-Premises Connector.