SecurityTokenService.GetSecurityTokenHandler(String) Method

Definition

Gets the appropriate security token handler for issuing a security token of the specified type.

protected:
 virtual System::IdentityModel::Tokens::SecurityTokenHandler ^ GetSecurityTokenHandler(System::String ^ requestedTokenType);
protected virtual System.IdentityModel.Tokens.SecurityTokenHandler GetSecurityTokenHandler (string requestedTokenType);
abstract member GetSecurityTokenHandler : string -> System.IdentityModel.Tokens.SecurityTokenHandler
override this.GetSecurityTokenHandler : string -> System.IdentityModel.Tokens.SecurityTokenHandler
Protected Overridable Function GetSecurityTokenHandler (requestedTokenType As String) As SecurityTokenHandler

Parameters

requestedTokenType
String

A string that contains the requested token type URI.

Returns

SecurityTokenHandler

A SecurityTokenHandler that represents the token handler to be used for creating the issued security token. Returns null if the requested token type is not supported (there is no handler configured for the specified token type).

Remarks

In the default implementation if requestedTokenType is null or an empty string, the default token type from configuration is used. This is specified by the DefaultTokenType property of the STS configuration object accessed through the SecurityTokenServiceConfiguration property.

This method is called from the default token issuance pipeline implemented in the Issue method.

Applies to

See also