skip to main content
Hybrid Data Pipeline API reference : Administrators API : Authentication API : Get information on an authentication type
  

Try Now
Get information on an authentication type

Purpose

Retrieves information on an authentication type.

URL

https://<myserver>:<port>/api/admin/auth/types/{id}

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.
The URL parameter {id} is required.
Parameter
Description
Valid Values
{id}
The ID of the authentication type.
1 | 2 | 3
1 is the ID for the internal authentication type.
2 is the ID for a service that uses a Java plugin.
3 is the ID for a service that uses LDAP.

Response Definition

The response has the following format.
{
"id": authtype_id,
"name": "authtype_name",
"description": "authtype_description",
"authDefinition": {
"className": "javaplugin_classname_info",
"attributes": {authdefinition_attributes}
}
}
Properties
Description
Valid Values
"id"
The ID of the authentication type.
1 | 2 | 3
1 is the ID for the internal authentication type.
2 is the ID for a service that uses a Java plugin.
3 is the ID for a service that uses LDAP.
"name"
The name of the authentication type.
A string that specifies the name of the authentication type.
"description"
The description of the authentication type.
A string that provides the description of the authentication type.
"authDefinition"
Information that describes the authentication type.
The value of authDefinition varies depending on which type is queried. A value of null is provided for the internal authentication service. See the example responses below.

Sample Server Success Response

The response payload varies depending on which authentication type is queried.
Internal authentication type
Status code: 200
Successful response
{
"id": 1,
"name": "Internal",
"description": "Password stored in service. The default HDP authentication.",
"authDefinition": null
}
Java plugin authentication type
Status code: 200
Successful response
{
"id": 2,
"name": "Java Auth Plugin",
"description": "An authentication service that implements a Java Authentication plugin interface.",
"authDefinition": {
"className": "Specify a concrete class name that implements Java Authentication Plugin Interface. Eg. com.sample.plugins.auth.JavaPluginAuthSample",
"attributes": "This is optional. Attributes can take any valid JSON Object."
}
}
LDAP authentication type
Status code: 200
Successful response
{
"id": 3,
"name": "LDAP Auth Plugin",
"description": "An authentication service that authenticates User with LDAP.",
"authDefinition": {
"attributes": {
"targetUrl": "<ldap server url>",
"securityAuthentication": "<auth mechanism none,simple,sasl_mech>",
"securityPrincipal": "<dn with loginname token>",
"otherAttributes": "<This is Optional. JSON Object with key and value pairs which needs to be passed in environment properties while creating InitialDirContext obj>"
}
}
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have either the Administrator (12) permission, or the RegisterExternalAuthService (26) permission and administrative access to the tenant.