/
AcquireTokenOnBehalfOfParameterBuilder.xml
187 lines (187 loc) · 12.6 KB
/
AcquireTokenOnBehalfOfParameterBuilder.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
<Type Name="AcquireTokenOnBehalfOfParameterBuilder" FullName="Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder">
<TypeSignature Language="C#" Value="public sealed class AcquireTokenOnBehalfOfParameterBuilder : Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit AcquireTokenOnBehalfOfParameterBuilder extends Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1<class Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class AcquireTokenOnBehalfOfParameterBuilder
Inherits AbstractConfidentialClientAcquireTokenParameterBuilder(Of AcquireTokenOnBehalfOfParameterBuilder)" />
<TypeSignature Language="F#" Value="type AcquireTokenOnBehalfOfParameterBuilder = class
 inherit AbstractConfidentialClientAcquireTokenParameterBuilder<AcquireTokenOnBehalfOfParameterBuilder>" />
<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>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="T">Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<summary>
Builder for AcquireTokenOnBehalfOf (OBO flow)
See https://aka.ms/msal-net-on-behalf-of
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="protected override void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.Validate" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="acquireTokenOnBehalfOfParameterBuilder.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="WithCcsRoutingHint">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder WithCcsRoutingHint (string userName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder WithCcsRoutingHint(string userName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithCcsRoutingHint(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function WithCcsRoutingHint (userName As String) As AcquireTokenOnBehalfOfParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithCcsRoutingHint : string -> Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder" Usage="acquireTokenOnBehalfOfParameterBuilder.WithCcsRoutingHint userName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="userName" Type="System.String" />
</Parameters>
<Docs>
<param name="userName">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param>
<summary>
To help with resiliency, the AAD backup authentication system operates as an AAD backup.
This will provide the AAD backup authentication system with a routing hint to help improve performance during authentication.
</summary>
<returns>The builder to chain the .With methods</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithCcsRoutingHint">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder WithCcsRoutingHint (string userObjectIdentifier, string tenantIdentifier);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder WithCcsRoutingHint(string userObjectIdentifier, string tenantIdentifier) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithCcsRoutingHint(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function WithCcsRoutingHint (userObjectIdentifier As String, tenantIdentifier As String) As AcquireTokenOnBehalfOfParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithCcsRoutingHint : string * string -> Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder" Usage="acquireTokenOnBehalfOfParameterBuilder.WithCcsRoutingHint (userObjectIdentifier, tenantIdentifier)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="userObjectIdentifier" Type="System.String" />
<Parameter Name="tenantIdentifier" Type="System.String" />
</Parameters>
<Docs>
<param name="userObjectIdentifier">GUID which is unique to the user, parsed from the client_info.</param>
<param name="tenantIdentifier">GUID format of the tenant ID, parsed from the client_info.</param>
<summary>
To help with resiliency, the AAD backup authentication system operates as an AAD backup.
This will provide the AAD backup authentication system with a routing hint to help improve performance during authentication.
</summary>
<returns>The builder to chain the .With methods</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithForceRefresh">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder WithForceRefresh (bool forceRefresh);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder WithForceRefresh(bool forceRefresh) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithForceRefresh(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function WithForceRefresh (forceRefresh As Boolean) As AcquireTokenOnBehalfOfParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithForceRefresh : bool -> Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder" Usage="acquireTokenOnBehalfOfParameterBuilder.WithForceRefresh forceRefresh" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="forceRefresh" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="forceRefresh">If <c>true</c>, ignore any access token in the user token cache
and attempt to acquire new access token using the refresh token for the account
if one is available. This can be useful in the case when the application developer wants to make
sure that conditional access policies are applied immediately, rather than after the expiration of the access token.
The default is <c>false</c></param>
<summary>
Specifies if the client application should force refreshing the
token from the user token cache. By default the token is taken from the
the user token cache (forceRefresh=false)
</summary>
<returns>The builder to chain the .With methods</returns>
<remarks>Avoid unnecessarily setting <paramref name="forceRefresh" /> to <c>true</c> true in order to
avoid negatively affecting the performance of your application</remarks>
</Docs>
</Member>
<Member MemberName="WithSendX5C">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder WithSendX5C (bool withSendX5C);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder WithSendX5C(bool withSendX5C) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithSendX5C(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function WithSendX5C (withSendX5C As Boolean) As AcquireTokenOnBehalfOfParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithSendX5C : bool -> Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder" Usage="acquireTokenOnBehalfOfParameterBuilder.WithSendX5C withSendX5C" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="withSendX5C" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="withSendX5C">
<c>true</c> if the x5c should be sent. Otherwise <c>false</c>.
The default is <c>false</c></param>
<summary>
Applicable to first-party applications only, this method also allows to specify
if the <see href="https://datatracker.ietf.org/doc/html/rfc7517#section-4.7">x5c claim</see> should be sent to Azure AD.
Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD:
this method will send the certificate chain 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). For details see https://aka.ms/msal-net-sni
</summary>
<returns>The builder to chain the .With methods</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>