Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated comments on RoleClaimTypeRetriever and NameClaimTypeRetriever #1960

Merged
merged 1 commit into from
Nov 17, 2022
Merged

Updated comments on RoleClaimTypeRetriever and NameClaimTypeRetriever #1960

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions src/Microsoft.IdentityModel.Tokens/TokenValidationParameters.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -571,9 +571,14 @@ public string NameClaimType
}

/// <summary>
/// Gets or sets a delegate that will be called to obtain the NameClaimType to use when creating a ClaimsIdentity
/// after validating a token.
/// Gets or sets a delegate that will be called to set the property <see cref="ClaimsIdentity.NameClaimType"/> after validating a token.
/// </summary>
/// <remarks>
/// The function will be passed:
/// <para>The <see cref="SecurityToken"/> that is being validated.</para>
/// <para>The issuer associated with the token.</para>
/// <para>Returns the value that will set the property <see cref="ClaimsIdentity.NameClaimType"/>.</para>
/// </remarks>
public Func<SecurityToken, string, string> NameClaimTypeRetriever { get; set; }

/// <summary>
Expand Down Expand Up @@ -636,9 +641,14 @@ public string RoleClaimType
}

/// <summary>
/// Gets or sets a delegate that will be called to obtain the RoleClaimType to use when creating a ClaimsIdentity
/// after validating a token.
/// Gets or sets a delegate that will be called to set the property <see cref="ClaimsIdentity.RoleClaimType"/> after validating a token.
/// </summary>
/// <remarks>
/// The function will be passed:
/// <para>The <see cref="SecurityToken"/> that is being validated.</para>
/// <para>The issuer associated with the token.</para>
/// <para>Returns the value that will set the property <see cref="ClaimsIdentity.RoleClaimType"/>.</para>
/// </remarks>
public Func<SecurityToken, string, string> RoleClaimTypeRetriever { get; set; }

/// <summary>
Expand Down