DeleteIdpConfiguration

01/07/2025 Contributors

You can use the DeleteIdpConfiguration method to delete an existing configuration of a third-party IdP for the cluster. Deleting the last IdP configuration removes the SAML Service Provider certificate from the cluster.

Parameters

This method has the following input parameters:

Name	Description	Type	Default value	Required
idpConfigurationID	UUID for the third-party IdP configuration.	UUID	None	No
idpName	Name used to identify and retrieve an IdP provider for SAML 2.0 single sign-on.	string	None	No

Name

Description

Type

Default value

Required

idpConfigurationID

UUID for the third-party IdP configuration.

UUID

None

idpName

Name used to identify and retrieve an IdP provider for SAML 2.0 single sign-on.

string

None

Return values

This method has no return values.

Request example

Requests for this method are similar to the following example:

{
  "method": "DeleteIdpConfiguration",
  "params": {
    "idpConfigurationID": "f983c602-12f9-4c67-b214-bf505185cfed",
    "idpName": "https://provider.name.url.com"
  }
}

Response example

This method returns a response similar to the following example:

{
  "result":{}
}

New since version

12.0