ISSOMapper.SetExternalCredentials Method

Artigo
10/17/2023

The SetExternalCredentials method stores a set of external credentials in the Enterprise Single Sign-On (SSO) server database.

Syntax

  
HRESULT SetExternalCredentials(  
BSTR bstrApplicationName,  
BSTR bstrExternalUserName,  
SAFEARRAY externalCredentials  
);

  
[Visual Basic]  
Sub SetExternalCredentials(  
bstrApplicationName As String,  
bstrExternalUserName As String,  
externalCredentials 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.

bstrExternalUserName
[in] String that specifies the external user name.

externalCredentials
[in] String array that specifies the external credentials to be stored.

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

Users described as Application User can only set their own credentials. Also, the number of external credentials provided must match the number of fields expected by the external application.

Requirements

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

Partilhar via