skip to main content
Hybrid Data Pipeline API reference : Administrators API : Users API : Get authentication information

Try Now
Get authentication information


Returns authentication information on a user account. The response includes the authentication user(s) and service(s) that belong to the user account.





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.
The URL parameter "id" described in the following table is required.
Valid Values
The ID of the user account
The ID is auto-generated when the user account is created and cannot be changed.

Response Definition

The response takes the following format. The properties of the response are described in the table that follows.
"authUsers": [
"authUserName": "string",
"authServiceId": integer
Valid Values
The name of the authentication user.
A string where the string specifies a user name persisted by the authentication service. The maximum length is 128 characters.
The ID of the authentication service against which the user is authenticating.
1 | x
1 is the ID for the default internal authentication service.
x is an auto-generated ID for an external authentication service implemented by an administrator.

Sample Server Response

Note: The response will not return settings for optional properties that were not set in a previous POST or PUT request.

Status code: 200
Successful response
"authUsers": [
"authUserName": "testuser",
"authServiceId": 1

Sample Server Failure Response

"value":"There is no User with that id: 123."


Basic Authentication using Login ID and Password


The user must have the Administrator (12) permission, or the ViewUsers (14) permission and administrative access on the tenant.