Clears the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).

Usage notes

If single sign-on (SSO) logon is disabled, you can clear the configurations of a SAML IdP. If SSO logon is enabled, you cannot clear the configurations.

This topic provides an example on how to clear the configurations of the SAML IdP within the directory d-00fc2p61****.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ClearExternalSAMLIdentityProvider

The operation that you want to perform. Set the value to ClearExternalSAMLIdentityProvider.

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String 96D1E5FF-0301-5636-8D33-071E033CFB82

The ID of the request.

Examples

Sample requests

https://[Endpoint]/?Action=ClearExternalSAMLIdentityProvider
&DirectoryId=d-00fc2p61****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ClearExternalSAMLIdentityProviderResponse>
    <RequestId>96D1E5FF-0301-5636-8D33-071E033CFB82</RequestId>
</ClearExternalSAMLIdentityProviderResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "96D1E5FF-0301-5636-8D33-071E033CFB82"
}

Error codes

For a list of error codes, visit the API Error Center.