Skip to content

Commit

Permalink
Updated comments on RoleClaimTypeRetriever and NameClaimTypeRetriever
Browse files Browse the repository at this point in the history
  • Loading branch information
brentschmaltz committed Nov 17, 2022
1 parent 3fdee1c commit cd8beaa
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions src/Microsoft.IdentityModel.Tokens/TokenValidationParameters.cs
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

0 comments on commit cd8beaa

Please sign in to comment.