Purpose

Retrieves supported authentication types.

URL

https://<myserver>:<port>/api/admin/auth/types

Method

GET

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.

Response Definition

The response takes the following format.

{
    "authTypes": [
        {
            "id": authtype_id,
            "name": "authtype_name",
            "description": "authtype_description"
        },
        ...
    ]
}
Property Description Valid Values
"id" The ID of the authentication type. 1 | 2 | 3 | 4 | 5

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.

4 is the ID for a service that uses a SAML plugin.

5 is the ID for a service that uses OIDC.
"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.
"grantedPermissions" A list of additional permissions that the user is assigned. Required
"revokedPermissions" A list of permissions that the user is denied. Required

Sample Server Success Response 

Status code: 200
Successful response
{
    "authTypes": [
        {
            "id": 1,
            "name": "Internal",
            "description": "Password stored in service. The default HDP authentication."
        },
        {
            "id": 2,
            "name": "Java Auth Plugin",
            "description": "An authentication service that implements a Java Authentication plugin interface."
        },
        {
            "id": 3,
            "name": "LDAP Auth Plugin",
            "description": "An authentication service that authenticates User with LDAP."
        },
        {
            "id": 4,
            "name": "SAML Auth Plugin",
            "description": "An authentication service that authenticates User with a SAML provider."
        },
        {
            "id": 5,
            "name": "OIDC Auth Plugin",
            "description": "An authentication service that authenticates User with an OpenID provider."
            } 
    ]
}

Sample Server Failure Response 

Status code: 403
Forbidden

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.