Purpose

Retrieves authentication services.

URL

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

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.

{
    "authServices": [
        {
            "id": authservice_id,
            "name": "authservice_id",
            "tenantId": tenant_id,
            "description": "authservice_description",
            "tenantName": tenant_name
        },
        ...
    ]
}
Property Description Valid Values
"id" The ID of the authentication service. The automatically generated external authentication service ID.
"name" The name of the authentication service. A string that provides a name for the authentication service.
"tenantId" The ID of the tenant. A valid tenant ID.
"description" The description of the authentication service. A string that provides a description for the authentication service.
"tenantName" The name of the tenant.

Only supplied when the URL is appended with the details query parameter set to true (?details=true).

 A string that specifies the name of the tenant.

Sample Server Success Response 

Status code: 200
Successful response
{
    "authServices": [
        {
            "id": 1,
            "name": "Internal",
            "tenantId": 1,
            "description": "The default internal authentication service.",
            "tenantName": "System"
        },
        {
            "id": 164,
            "name": "jauthplugin",
            "tenantId": 103,
            "description": "Java authentication plugin",
            "tenantName": "OrgR"
        },
        {
            "id": 21,
            "name": "LDAP",
            "tenantId": 43,
            "description": "LDAP Auth plugin",
            "tenantName": "OrgL"
        },      
        {
            "id": 4,
            "name": "SAML",
            "tenantId": 2,
            "description": "SAML authentication plugin",
            "tenantName": "OrgS"
        },
        {
            "id": 5,
            "name": "OIDC",
            "tenantId": 35,
            "description": "OIDC authentication plugin",
            "tenantName": "OrgT"
        }
    ]
}

Sample Server Failure Response 

{
   "error":{
      "code": 222208103,
      "message":{
         "lang":"en-US",
         "value":"You lack the permissions to access this url."
      }
   }
}

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.