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

Try Now
Get Authorized Users

Purpose

Retrieve the list of users who have been granted permission to use a particular On-Premises Connector.

URL

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

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

Response Definition

The response 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 Server Response


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

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.