SecurityTokenResolver.TryResolveToken Method

Definition

Attempts to retrieve the security token that is referenced in the specified object.

Overloads

TryResolveToken(SecurityKeyIdentifier, SecurityToken)

Attempts to retrieve the security token that matches one of the key identifier clauses contained within the specified key identifier.

TryResolveToken(SecurityKeyIdentifierClause, SecurityToken)

Attempts to retrieve the security token that matches the specified key identifier clause.

TryResolveToken(SecurityKeyIdentifier, SecurityToken)

Attempts to retrieve the security token that matches one of the key identifier clauses contained within the specified key identifier.

public:
 bool TryResolveToken(System::IdentityModel::Tokens::SecurityKeyIdentifier ^ keyIdentifier, [Runtime::InteropServices::Out] System::IdentityModel::Tokens::SecurityToken ^ % token);
public bool TryResolveToken (System.IdentityModel.Tokens.SecurityKeyIdentifier keyIdentifier, out System.IdentityModel.Tokens.SecurityToken token);
member this.TryResolveToken : System.IdentityModel.Tokens.SecurityKeyIdentifier * SecurityToken -> bool
Public Function TryResolveToken (keyIdentifier As SecurityKeyIdentifier, ByRef token As SecurityToken) As Boolean

Parameters

keyIdentifier
SecurityKeyIdentifier

The SecurityKeyIdentifier to create a security token for.

token
SecurityToken

When this method returns, contains a SecurityToken that represents the specified key identifier. This parameter is passed uninitialized.

Returns

Boolean

true when a security token can be retrieved for the specified key identifier; otherwise, false.

Exceptions

keyIdentifier is null.

Remarks

The TryResolveToken and ResolveToken methods differ in what happens when the key identifier cannot be resolved to a security token. The TryResolveToken method returns false, whereas the ResolveToken method throws an exception.

Applies to

TryResolveToken(SecurityKeyIdentifierClause, SecurityToken)

Attempts to retrieve the security token that matches the specified key identifier clause.

public:
 bool TryResolveToken(System::IdentityModel::Tokens::SecurityKeyIdentifierClause ^ keyIdentifierClause, [Runtime::InteropServices::Out] System::IdentityModel::Tokens::SecurityToken ^ % token);
public bool TryResolveToken (System.IdentityModel.Tokens.SecurityKeyIdentifierClause keyIdentifierClause, out System.IdentityModel.Tokens.SecurityToken token);
member this.TryResolveToken : System.IdentityModel.Tokens.SecurityKeyIdentifierClause * SecurityToken -> bool
Public Function TryResolveToken (keyIdentifierClause As SecurityKeyIdentifierClause, ByRef token As SecurityToken) As Boolean

Parameters

keyIdentifierClause
SecurityKeyIdentifierClause

The SecurityKeyIdentifierClause to create a security token for.

token
SecurityToken

When this method returns, contains a SecurityToken that represents the specified key identifier clause. This parameter is passed uninitialized.

Returns

Boolean

true when a security token can be retrieved for the specified key identifier clause; otherwise, false.

Exceptions

keyIdentifierClause is null.

Remarks

The TryResolveToken and ResolveToken methods differ in what happens when the key identifier clause cannot be resolved to a security token. The TryResolveToken method returns false, whereas the ResolveToken method throws an exception.

Applies to