-
Notifications
You must be signed in to change notification settings - Fork 26
/
AadIssuerValidator.xml
153 lines (153 loc) Β· 10.1 KB
/
AadIssuerValidator.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<Type Name="AadIssuerValidator" FullName="Microsoft.IdentityModel.Validators.AadIssuerValidator">
<TypeSignature Language="C#" Value="public class AadIssuerValidator" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AadIssuerValidator extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.IdentityModel.Validators.AadIssuerValidator" />
<TypeSignature Language="VB.NET" Value="Public Class AadIssuerValidator" />
<TypeSignature Language="F#" Value="type AadIssuerValidator = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Validators</AssemblyName>
<AssemblyVersion>6.27.0.0</AssemblyVersion>
<AssemblyVersion>6.28.1.0</AssemblyVersion>
<AssemblyVersion>6.29.0.0</AssemblyVersion>
<AssemblyVersion>6.30.0.0</AssemblyVersion>
<AssemblyVersion>6.30.1.0</AssemblyVersion>
<AssemblyVersion>6.31.0.0</AssemblyVersion>
<AssemblyVersion>6.32.0.0</AssemblyVersion>
<AssemblyVersion>6.32.1.0</AssemblyVersion>
<AssemblyVersion>6.32.2.0</AssemblyVersion>
<AssemblyVersion>6.32.3.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.2.0</AssemblyVersion>
<AssemblyVersion>7.0.3.0</AssemblyVersion>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
<AssemblyVersion>7.3.1.0</AssemblyVersion>
<AssemblyVersion>7.4.0.0</AssemblyVersion>
<AssemblyVersion>7.4.1.0</AssemblyVersion>
<AssemblyVersion>7.5.0.0</AssemblyVersion>
<AssemblyVersion>7.5.1.0</AssemblyVersion>
<AssemblyVersion>7.5.2.0</AssemblyVersion>
<AssemblyVersion>7.6.0.0</AssemblyVersion>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Generic class that validates the issuer for either JsonWebTokens or JwtSecurityTokens issued from the Microsoft identity platform (AAD).
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetAadIssuerValidator">
<MemberSignature Language="C#" Value="public static Microsoft.IdentityModel.Validators.AadIssuerValidator GetAadIssuerValidator (string aadAuthority);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.IdentityModel.Validators.AadIssuerValidator GetAadIssuerValidator(string aadAuthority) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Validators.AadIssuerValidator.GetAadIssuerValidator(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function GetAadIssuerValidator (aadAuthority As String) As AadIssuerValidator" />
<MemberSignature Language="F#" Value="static member GetAadIssuerValidator : string -> Microsoft.IdentityModel.Validators.AadIssuerValidator" Usage="Microsoft.IdentityModel.Validators.AadIssuerValidator.GetAadIssuerValidator aadAuthority" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Validators</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.IdentityModel.Validators.AadIssuerValidator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="aadAuthority" Type="System.String" />
</Parameters>
<Docs>
<param name="aadAuthority">The authority to create the validator for, e.g. https://login.microsoftonline.com/. </param>
<summary>
Gets an <see cref="T:Microsoft.IdentityModel.Validators.AadIssuerValidator" /> for an Azure Active Directory (AAD) authority.
</summary>
<returns>A <see cref="T:Microsoft.IdentityModel.Validators.AadIssuerValidator" /> for the aadAuthority.</returns>
<remarks>To be added.</remarks>
<example>
<code>
AadIssuerValidator aadIssuerValidator = AadIssuerValidator.GetAadIssuerValidator(authority);
TokenValidationParameters.IssuerValidator = aadIssuerValidator.Validate;
</code>
</example>
<exception cref="T:System.ArgumentNullException">if <paramref name="aadAuthority" /> is null or empty.</exception>
</Docs>
</Member>
<Member MemberName="GetAadIssuerValidator">
<MemberSignature Language="C#" Value="public static Microsoft.IdentityModel.Validators.AadIssuerValidator GetAadIssuerValidator (string aadAuthority, System.Net.Http.HttpClient httpClient);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.IdentityModel.Validators.AadIssuerValidator GetAadIssuerValidator(string aadAuthority, class System.Net.Http.HttpClient httpClient) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Validators.AadIssuerValidator.GetAadIssuerValidator(System.String,System.Net.Http.HttpClient)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function GetAadIssuerValidator (aadAuthority As String, httpClient As HttpClient) As AadIssuerValidator" />
<MemberSignature Language="F#" Value="static member GetAadIssuerValidator : string * System.Net.Http.HttpClient -> Microsoft.IdentityModel.Validators.AadIssuerValidator" Usage="Microsoft.IdentityModel.Validators.AadIssuerValidator.GetAadIssuerValidator (aadAuthority, httpClient)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Validators</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.IdentityModel.Validators.AadIssuerValidator</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="aadAuthority" Type="System.String" />
<Parameter Name="httpClient" Type="System.Net.Http.HttpClient" />
</Parameters>
<Docs>
<param name="aadAuthority">The authority to create the validator for, e.g. https://login.microsoftonline.com/. </param>
<param name="httpClient">Optional HttpClient to use to retrieve the endpoint metadata (can be null).</param>
<summary>
Gets an <see cref="T:Microsoft.IdentityModel.Validators.AadIssuerValidator" /> for an Azure Active Directory (AAD) authority.
</summary>
<returns>A <see cref="T:Microsoft.IdentityModel.Validators.AadIssuerValidator" /> for the aadAuthority.</returns>
<remarks>To be added.</remarks>
<example>
<code>
AadIssuerValidator aadIssuerValidator = AadIssuerValidator.GetAadIssuerValidator(authority, httpClient);
TokenValidationParameters.IssuerValidator = aadIssuerValidator.Validate;
</code>
</example>
<exception cref="T:System.ArgumentNullException">if <paramref name="aadAuthority" /> is null or empty.</exception>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public string Validate (string issuer, Microsoft.IdentityModel.Tokens.SecurityToken securityToken, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string Validate(string issuer, class Microsoft.IdentityModel.Tokens.SecurityToken securityToken, class Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Validators.AadIssuerValidator.Validate(System.String,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)" />
<MemberSignature Language="VB.NET" Value="Public Function Validate (issuer As String, securityToken As SecurityToken, validationParameters As TokenValidationParameters) As String" />
<MemberSignature Language="F#" Value="member this.Validate : string * Microsoft.IdentityModel.Tokens.SecurityToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> string" Usage="aadIssuerValidator.Validate (issuer, securityToken, validationParameters)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Validators</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="issuer" Type="System.String" />
<Parameter Name="securityToken" Type="Microsoft.IdentityModel.Tokens.SecurityToken" />
<Parameter Name="validationParameters" Type="Microsoft.IdentityModel.Tokens.TokenValidationParameters" />
</Parameters>
<Docs>
<param name="issuer">Issuer to validate (will be tenanted).</param>
<param name="securityToken">Received security token.</param>
<param name="validationParameters">Token validation parameters.</param>
<summary>
Validate the issuer for single and multi-tenant applications of various audiences (Work and School accounts, or Work and School accounts +
Personal accounts) and the various clouds.
</summary>
<returns>The <c>issuer</c> if it's valid, or otherwise <c>SecurityTokenInvalidIssuerException</c> is thrown.</returns>
<remarks>The issuer is considered as valid if it has the same HTTP scheme and authority as the
authority from the configuration file, has a tenant ID, and optionally v2.0 (if this web API
accepts both V1 and V2 tokens).</remarks>
<example>
<code>
AadIssuerValidator aadIssuerValidator = AadIssuerValidator.GetAadIssuerValidator(authority, httpClient);
TokenValidationParameters.IssuerValidator = aadIssuerValidator.Validate;
</code>
</example>
<exception cref="T:System.ArgumentNullException"> if <paramref name="validationParameters" /> is null.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">if the issuer is invalid or if there is a network issue. </exception>
</Docs>
</Member>
</Members>
</Type>