ISSOAdmin.PurgeCacheForApplication Method

Article
10/17/2023

The PurgeCacheForApplication method purges the cached credentials for an application on all Enterprise Single Sign-On (SSO) servers.

Syntax

  
HRESULT PurgeCacheForApplication(  
BSTR bstrApplicationName  
);

  
Sub PurgeCacheForApplication(  
bstrApplicationName As String  
)

Parameters

bstrApplicationName
[in] String that specifies the application name. This parameter cannot be NULL, an empty string, or contain spaces. Application names are not case-sensitive, but case will be preserved. For example, ABC, abc, and AbC are considered to be the same application.

Return Value

This method returns an HRESULT indicating whether it completed successfully. For more details, see the Error Values section.

Not applicable.

Error Values

This method returns an HRESULT containing one of the values in the following table.

This method indicates errors by setting the Number property of the global Err object to one of the values in the following table.

Value	Description
S_OK	The method succeeded.
E_ACCESSDENIED	Access is denied to the caller.
E_INVALIDARG	An invalid parameter was detected.

Remarks

There may be a short time delay while this operation is applied to all SSO servers.

To access this method, you must be an SSO Administrator, SSO Affiliate Administrator, or an Application Administrator.

Requirements

Platforms: Windows Server 2022, Windows Server 2019, Windows Server 2016, Windows 11, and Windows 10

Share via