skip to main content
Hybrid Data Pipeline API reference : Management API : Connector API : Add Authorized Users
  

Try Now
Add Authorized Users

Purpose

Add authorized Hybrid Data Pipeline users to an On-Premises Connector’s access control list. The user account can be inactive. If a user name is invalid, an error is returned and none of the specified users are added to the access control list.
Note: The list of users is limited to a system-configurable value. If you need to add more authorized users, use additional POST calls to add them. If too many users are provided, an error message that specifies the limit is returned.

URL

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

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.
<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>,
]
}
Parameter
Data Type
Description
Valid Values
authUser [authorized-user ]
Array [String]
Specifies the Hybrid Data Pipeline users who are authorized to use the On-Premises Connector.
authorized-user is a Hybrid Data Pipeline user who is authorized to use the On-Premises Connector.

Sample Request


{
"authUser": [
"Joe",
"Fred",
"Tom"
]
}

Response Definition

If the Add Authorized User operation requested is successful, the response is a JSON object defined as:
{
"success": true
}
If the Add Authorized User operation is not successful, the response is a standard error response

Sample Server 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.