-
Notifications
You must be signed in to change notification settings - Fork 30
/
IConfidentialClientApplicationWithCertificate.xml
207 lines (207 loc) · 16.7 KB
/
IConfidentialClientApplicationWithCertificate.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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<Type Name="IConfidentialClientApplicationWithCertificate" FullName="Microsoft.Identity.Client.IConfidentialClientApplicationWithCertificate">
<TypeSignature Language="C#" Value="public interface IConfidentialClientApplicationWithCertificate" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IConfidentialClientApplicationWithCertificate" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.IConfidentialClientApplicationWithCertificate" />
<TypeSignature Language="VB.NET" Value="Public Interface IConfidentialClientApplicationWithCertificate" />
<TypeSignature Language="F#" Value="type IConfidentialClientApplicationWithCertificate = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.48.1.0</AssemblyVersion>
<AssemblyVersion>4.49.1.0</AssemblyVersion>
<AssemblyVersion>4.51.0.0</AssemblyVersion>
<AssemblyVersion>4.52.0.0</AssemblyVersion>
<AssemblyVersion>4.53.0.0</AssemblyVersion>
<AssemblyVersion>4.54.0.0</AssemblyVersion>
<AssemblyVersion>4.54.1.0</AssemblyVersion>
<AssemblyVersion>4.55.0.0</AssemblyVersion>
<AssemblyVersion>4.56.0.0</AssemblyVersion>
<AssemblyVersion>4.57.0.0</AssemblyVersion>
<AssemblyVersion>4.58.0.0</AssemblyVersion>
<AssemblyVersion>4.58.1.0</AssemblyVersion>
<AssemblyVersion>4.59.0.0</AssemblyVersion>
<AssemblyVersion>4.60.0.0</AssemblyVersion>
<AssemblyVersion>4.60.1.0</AssemblyVersion>
<AssemblyVersion>4.60.2.0</AssemblyVersion>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
<AssemblyVersion>4.61.0.0</AssemblyVersion>
<AssemblyVersion>4.61.1.0</AssemblyVersion>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
<AssemblyVersion>4.62.0.0</AssemblyVersion>
<AssemblyVersion>4.63.0.0</AssemblyVersion>
<AssemblyVersion>4.64.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
Component to be used with confidential client applications like web apps/APIs.
This component supports Subject Name + Issuer authentication in order to help, in the future,
Azure AD certificates rollover.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AcquireTokenForClientWithCertificateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult> AcquireTokenForClientWithCertificateAsync (System.Collections.Generic.IEnumerable<string> scopes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Identity.Client.AuthenticationResult> AcquireTokenForClientWithCertificateAsync(class System.Collections.Generic.IEnumerable`1<string> scopes) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.IConfidentialClientApplicationWithCertificate.AcquireTokenForClientWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Function AcquireTokenForClientWithCertificateAsync (scopes As IEnumerable(Of String)) As Task(Of AuthenticationResult)" />
<MemberSignature Language="F#" Value="abstract member AcquireTokenForClientWithCertificateAsync : seq<string> -> System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult>" Usage="iConfidentialClientApplicationWithCertificate.AcquireTokenForClientWithCertificateAsync scopes" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.64.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("Use AcquireTokenForClient instead. See https://aka.ms/msal-net-3-breaking-changes. ", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use AcquireTokenForClient instead. See https://aka.ms/msal-net-3-breaking-changes. ", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scopes" Type="System.Collections.Generic.IEnumerable<System.String>" />
</Parameters>
<Docs>
<param name="scopes">Array of scopes requested for resource</param>
<summary>
[V2 API] Acquires token from the service for the confidential client using the client credentials flow. (See https://aka.ms/msal-net-client-credentials)
This method enables application developers to achieve easy certificates roll-over
in Azure AD: this method will send the public certificate to Azure AD
along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy.
This saves the application admin from the need to explicitly manage the certificate rollover
(either via portal or PowerShell/CLI operation).
</summary>
<returns>Authentication result containing application token for the requested scopes</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AcquireTokenForClientWithCertificateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult> AcquireTokenForClientWithCertificateAsync (System.Collections.Generic.IEnumerable<string> scopes, bool forceRefresh);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Identity.Client.AuthenticationResult> AcquireTokenForClientWithCertificateAsync(class System.Collections.Generic.IEnumerable`1<string> scopes, bool forceRefresh) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.IConfidentialClientApplicationWithCertificate.AcquireTokenForClientWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function AcquireTokenForClientWithCertificateAsync (scopes As IEnumerable(Of String), forceRefresh As Boolean) As Task(Of AuthenticationResult)" />
<MemberSignature Language="F#" Value="abstract member AcquireTokenForClientWithCertificateAsync : seq<string> * bool -> System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult>" Usage="iConfidentialClientApplicationWithCertificate.AcquireTokenForClientWithCertificateAsync (scopes, forceRefresh)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.64.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("Use AcquireTokenForClient instead. See https://aka.ms/msal-net-3-breaking-changes. ", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use AcquireTokenForClient instead. See https://aka.ms/msal-net-3-breaking-changes. ", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scopes" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="forceRefresh" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="scopes">Array of scopes requested for resource</param>
<param name="forceRefresh">If TRUE, API will ignore the access token in the cache and attempt to acquire new access token using client credentials</param>
<summary>
[V2 API] Acquires token from the service for the confidential client using the client credentials flow. (See https://aka.ms/msal-net-client-credentials)
This method attempts to look up valid access token in the cache unless<paramref name="forceRefresh" /> is true
This method enables application developers to achieve easy certificates roll-over
in Azure AD: this method will send the public certificate to Azure AD
along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy.
This saves the application admin from the need to explicitly manage the certificate rollover
(either via portal or PowerShell/CLI operation)
</summary>
<returns>Authentication result containing application token for the requested scopes</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AcquireTokenOnBehalfOfWithCertificateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult> AcquireTokenOnBehalfOfWithCertificateAsync (System.Collections.Generic.IEnumerable<string> scopes, Microsoft.Identity.Client.UserAssertion userAssertion);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Identity.Client.AuthenticationResult> AcquireTokenOnBehalfOfWithCertificateAsync(class System.Collections.Generic.IEnumerable`1<string> scopes, class Microsoft.Identity.Client.UserAssertion userAssertion) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.IConfidentialClientApplicationWithCertificate.AcquireTokenOnBehalfOfWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)" />
<MemberSignature Language="VB.NET" Value="Public Function AcquireTokenOnBehalfOfWithCertificateAsync (scopes As IEnumerable(Of String), userAssertion As UserAssertion) As Task(Of AuthenticationResult)" />
<MemberSignature Language="F#" Value="abstract member AcquireTokenOnBehalfOfWithCertificateAsync : seq<string> * Microsoft.Identity.Client.UserAssertion -> System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult>" Usage="iConfidentialClientApplicationWithCertificate.AcquireTokenOnBehalfOfWithCertificateAsync (scopes, userAssertion)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.64.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("Use AcquireTokenForClient instead. See https://aka.ms/msal-net-3-breaking-changes. ", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use AcquireTokenForClient instead. See https://aka.ms/msal-net-3-breaking-changes. ", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scopes" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="userAssertion" Type="Microsoft.Identity.Client.UserAssertion" />
</Parameters>
<Docs>
<param name="scopes">Array of scopes requested for resource</param>
<param name="userAssertion">Instance of UserAssertion containing user's token.</param>
<summary>
[V2 API] Acquires token using On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of)
</summary>
<returns>Authentication result containing token of the user for the requested scopes</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AcquireTokenOnBehalfOfWithCertificateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult> AcquireTokenOnBehalfOfWithCertificateAsync (System.Collections.Generic.IEnumerable<string> scopes, Microsoft.Identity.Client.UserAssertion userAssertion, string authority);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Identity.Client.AuthenticationResult> AcquireTokenOnBehalfOfWithCertificateAsync(class System.Collections.Generic.IEnumerable`1<string> scopes, class Microsoft.Identity.Client.UserAssertion userAssertion, string authority) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.IConfidentialClientApplicationWithCertificate.AcquireTokenOnBehalfOfWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function AcquireTokenOnBehalfOfWithCertificateAsync (scopes As IEnumerable(Of String), userAssertion As UserAssertion, authority As String) As Task(Of AuthenticationResult)" />
<MemberSignature Language="F#" Value="abstract member AcquireTokenOnBehalfOfWithCertificateAsync : seq<string> * Microsoft.Identity.Client.UserAssertion * string -> System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult>" Usage="iConfidentialClientApplicationWithCertificate.AcquireTokenOnBehalfOfWithCertificateAsync (scopes, userAssertion, authority)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.64.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("Use AcquireTokenForClient instead. See https://aka.ms/msal-net-3-breaking-changes. ", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use AcquireTokenForClient instead. See https://aka.ms/msal-net-3-breaking-changes. ", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scopes" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="userAssertion" Type="Microsoft.Identity.Client.UserAssertion" />
<Parameter Name="authority" Type="System.String" />
</Parameters>
<Docs>
<param name="scopes">Array of scopes requested for resource</param>
<param name="userAssertion">Instance of UserAssertion containing user's token.</param>
<param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param>
<summary>
[V2 API] Acquires token using On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of)
</summary>
<returns>Authentication result containing token of the user for the requested scopes</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>