Delete Auth Source

During the deletion of the SSO SAML/VCF SSO auth source, the same 'username' and 'password' which has been used while the creating this sso auth source, should be sent to the payload object.
Note: Force flag is applicable only for VCF SSO auth source. If force is true, VMware Cloud Foundation Operations continues to attempt to delete the VCF SSO auth source even when errors occur.
If you set it to false, VMware Cloud Foundation Operations stops attempting to removethe auth source if VCF SSO server fails

Request

URI

DELETE

https://{api_host}/suite-api/api/auth/sources/{sourceId}

COPY

Path Parameters

string

sourceId

Required

Id of the auth source

Query Parameters

boolean

force

Optional

Constraints: default: false

This flag is applicable only to VCF SSO authentication sources.

Request Body

List of properties required for deletion of the auth source

name-values of type(s) application/json

Optional

"{\n  \"nameValuePairs\" : [ {\n    \"name\" : \"user-name\",\n    \"value\" : \"username\"\n  }, {\n    \"name\" : \"password\",\n    \"value\" : \"password\"\n  } ]\n}"

array of object

nameValuePairs

Optional

Represents a single name -> value tuple.

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

204

The auth source is deleted successfully

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X DELETE -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/suite-api/api/auth/sources/{sourceId}

On This Page

Description

Request

Path Parameters

Query Parameters

Request Body

Authentication

Response

204 Response Body

Auth Operations