-
Notifications
You must be signed in to change notification settings - Fork 25
/
AcquireTokenByUsernamePasswordParameterBuilder.xml
120 lines (120 loc) 路 8.66 KB
/
AcquireTokenByUsernamePasswordParameterBuilder.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
<Type Name="AcquireTokenByUsernamePasswordParameterBuilder" FullName="Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder">
<TypeSignature Language="C#" Value="public sealed class AcquireTokenByUsernamePasswordParameterBuilder : Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit AcquireTokenByUsernamePasswordParameterBuilder extends Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder`1<class Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class AcquireTokenByUsernamePasswordParameterBuilder
Inherits AbstractPublicClientAcquireTokenParameterBuilder(Of AcquireTokenByUsernamePasswordParameterBuilder)" />
<TypeSignature Language="F#" Value="type AcquireTokenByUsernamePasswordParameterBuilder = class
 inherit AbstractPublicClientAcquireTokenParameterBuilder<AcquireTokenByUsernamePasswordParameterBuilder>" />
<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>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="T">Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<summary>
Parameter builder for the <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.String)" />
operation. See https://aka.ms/msal-net-up
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="WithFederationMetadata">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder WithFederationMetadata (string federationMetadata);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder WithFederationMetadata(string federationMetadata) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder.WithFederationMetadata(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function WithFederationMetadata (federationMetadata As String) As AcquireTokenByUsernamePasswordParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithFederationMetadata : string -> Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder" Usage="acquireTokenByUsernamePasswordParameterBuilder.WithFederationMetadata federationMetadata" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="federationMetadata" Type="System.String" />
</Parameters>
<Docs>
<param name="federationMetadata">Federation metadata in the form of XML.</param>
<summary>
Enables MSAL to read the federation metadata for a WS-Trust exchange from the provided input instead of acquiring it from an endpoint.
This is only applicable for managed ADFS accounts. See https://aka.ms/MsalFederationMetadata.
</summary>
<returns>The builder to chain the .With methods</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithProofOfPossession">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder WithProofOfPossession (string nonce, System.Net.Http.HttpMethod httpMethod, Uri requestUri);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder WithProofOfPossession(string nonce, class System.Net.Http.HttpMethod httpMethod, class System.Uri requestUri) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder.WithProofOfPossession(System.String,System.Net.Http.HttpMethod,System.Uri)" />
<MemberSignature Language="VB.NET" Value="Public Function WithProofOfPossession (nonce As String, httpMethod As HttpMethod, requestUri As Uri) As AcquireTokenByUsernamePasswordParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithProofOfPossession : string * System.Net.Http.HttpMethod * Uri -> Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder" Usage="acquireTokenByUsernamePasswordParameterBuilder.WithProofOfPossession (nonce, httpMethod, requestUri)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nonce" Type="System.String" />
<Parameter Name="httpMethod" Type="System.Net.Http.HttpMethod" />
<Parameter Name="requestUri" Type="System.Uri" />
</Parameters>
<Docs>
<param name="nonce">Nonce of the protected resource (RP) which will be published as part of the WWWAuthenticate header associated with a 401 HTTP response
or as part of the AuthorityInfo header associated with 200 response. Set it here to make it part of the Signed HTTP Request part of the POP token.</param>
<param name="httpMethod">The HTTP method ("GET", "POST" etc.) method that will be bound to the token. If set to null, the PoP token will not be bound to the method.
Corresponds to the "m" part of the a signed HTTP request.</param>
<param name="requestUri">The URI to bind the signed HTTP request to.</param>
<summary>
Modifies the token acquisition request so that the acquired token is a Proof-of-Possession token (PoP), rather than a Bearer token.
PoP tokens are similar to Bearer tokens, but are bound to the HTTP request and to a cryptographic key, which MSAL can manage on Windows.
Note that only the host and path parts of the request URI will be bound.
See https://aka.ms/msal-net-pop
</summary>
<returns>The builder.</returns>
<remarks>
<list type="bullet">
<item>
<description>An Authentication header is automatically added to the request.</description>
</item>
<item>
<description>The PoP token is bound to the HTTP request, more specifically to the HTTP method (GET, POST, etc.) and to the Uri (path and query, but not query parameters).</description>
</item>
<item>
<description>Broker is required to use Proof-of-Possession on public clients.</description>
</item>
</list>
</remarks>
</Docs>
</Member>
</Members>
</Type>