Purpose

Removes an authentication service. The internal authentication service cannot be deleted.

URL

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

Method

DELETE

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.

The URL parameter {id} is required.

Property Description Valid Values
{id} The ID of the authentication service. The automatically generated external authentication service ID.

Sample Server Success Response 

Status code: 204
Request fulfilled

Sample Server Failure Response 

{
    "error": {
        "code": 222208085,
        "message": {
            "lang": "en-US",
            "value": "There is no Auth Service with the Id: 77."
        }
    }
}

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.