SamlSecurityTokenHandler.CreateSubject(SecurityTokenDescriptor) Method

Reference

Definition

Namespace:: Microsoft.IdentityModel.Tokens.Saml

Assembly:: Microsoft.IdentityModel.Tokens.Saml.dll

Package:: Microsoft.IdentityModel.Tokens.Saml v8.1.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the SamlSubject to use for all the statements that will be created. Overwrite this method to customize the creation of the SamlSubject.

protected virtual Microsoft.IdentityModel.Tokens.Saml.SamlSubject CreateSubject (Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor tokenDescriptor);

abstract member CreateSubject : Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor -> Microsoft.IdentityModel.Tokens.Saml.SamlSubject
override this.CreateSubject : Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor -> Microsoft.IdentityModel.Tokens.Saml.SamlSubject

Protected Overridable Function CreateSubject (tokenDescriptor As SecurityTokenDescriptor) As SamlSubject

Parameters

tokenDescriptor: SecurityTokenDescriptor

Contains all the information that is used in token issuance.

Returns

SamlSubject

A SamlSubject created from the first subject found in the tokenDescriptor as follows:

1. Claim of Type NameIdentifier is searched. If found, SamlSubject.Name is set to claim.Value. 2. If a non-null tokenDescriptor.proof is found then SamlSubject.KeyIdentifier = tokenDescriptor.Proof.KeyIdentifier AND SamlSubject.ConfirmationMethod is set to 'HolderOfKey'. 3. If a null tokenDescriptor.proof is found then SamlSubject.ConfirmationMethod is set to 'BearerKey'.

Exceptions

ArgumentNullException

if tokenDescriptor is null.

SamlSecurityTokenException

if the tokenDescriptor has more than one name identifier claim.

Applies to

Share via