-
Notifications
You must be signed in to change notification settings - Fork 32
/
BrokerExtension.xml
155 lines (153 loc) · 10.7 KB
/
BrokerExtension.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
<Type Name="BrokerExtension" FullName="Microsoft.Identity.Client.Broker.BrokerExtension">
<TypeSignature Language="C#" Value="public static class BrokerExtension" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit BrokerExtension extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.Broker.BrokerExtension" />
<TypeSignature Language="VB.NET" Value="Public Module BrokerExtension" />
<TypeSignature Language="F#" Value="type BrokerExtension = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client.Broker</AssemblyName>
<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>
<AssemblyVersion>4.64.1.0</AssemblyVersion>
<AssemblyVersion>4.65.0.0</AssemblyVersion>
<AssemblyVersion>4.66.0.0</AssemblyVersion>
<AssemblyVersion>4.66.1.0</AssemblyVersion>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
MSAL Broker Extension for WAM support
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="WithBroker">
<MemberSignature Language="C#" Value="public static Microsoft.Identity.Client.PublicClientApplicationBuilder WithBroker (this Microsoft.Identity.Client.PublicClientApplicationBuilder builder, Microsoft.Identity.Client.BrokerOptions brokerOptions);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Identity.Client.PublicClientApplicationBuilder WithBroker(class Microsoft.Identity.Client.PublicClientApplicationBuilder builder, class Microsoft.Identity.Client.BrokerOptions brokerOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.Broker.BrokerExtension.WithBroker(Microsoft.Identity.Client.PublicClientApplicationBuilder,Microsoft.Identity.Client.BrokerOptions)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function WithBroker (builder As PublicClientApplicationBuilder, brokerOptions As BrokerOptions) As PublicClientApplicationBuilder" />
<MemberSignature Language="F#" Value="static member WithBroker : Microsoft.Identity.Client.PublicClientApplicationBuilder * Microsoft.Identity.Client.BrokerOptions -> Microsoft.Identity.Client.PublicClientApplicationBuilder" Usage="Microsoft.Identity.Client.Broker.BrokerExtension.WithBroker (builder, brokerOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client.Broker</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.PublicClientApplicationBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="builder" Type="Microsoft.Identity.Client.PublicClientApplicationBuilder" RefType="this" />
<Parameter Name="brokerOptions" Type="Microsoft.Identity.Client.BrokerOptions" />
</Parameters>
<Docs>
<param name="builder" />
<param name="brokerOptions">This provides cross platform options for broker.</param>
<summary>
Brokers enable Single-Sign-On, device identification,and application identification verification,
while increasing the security of applications. Use this API to enable brokers on desktop platforms.
See https://aka.ms/msal-net-wam for more information on platform specific settings required to enable the broker such as redirect URIs.
</summary>
<returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder" /> from which to set more
parameters, and to create a public client application instance</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithBrokerPreview">
<MemberSignature Language="C#" Value="public static Microsoft.Identity.Client.PublicClientApplicationBuilder WithBrokerPreview (this Microsoft.Identity.Client.PublicClientApplicationBuilder builder, bool enableBroker = true);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Identity.Client.PublicClientApplicationBuilder WithBrokerPreview(class Microsoft.Identity.Client.PublicClientApplicationBuilder builder, bool enableBroker) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.Broker.BrokerExtension.WithBrokerPreview(Microsoft.Identity.Client.PublicClientApplicationBuilder,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function WithBrokerPreview (builder As PublicClientApplicationBuilder, Optional enableBroker As Boolean = true) As PublicClientApplicationBuilder" />
<MemberSignature Language="F#" Value="static member WithBrokerPreview : Microsoft.Identity.Client.PublicClientApplicationBuilder * bool -> Microsoft.Identity.Client.PublicClientApplicationBuilder" Usage="Microsoft.Identity.Client.Broker.BrokerExtension.WithBrokerPreview (builder, enableBroker)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client.Broker</AssemblyName>
<AssemblyVersion>4.66.2.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("This broker implementation is generally available. Use WithBroker(BrokerOptions) in Microsoft.Identity.Client.Broker package instead. See https://aka.ms/msal-net-wam for details.", false)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This broker implementation is generally available. Use WithBroker(BrokerOptions) in Microsoft.Identity.Client.Broker package instead. See https://aka.ms/msal-net-wam for details.", false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.PublicClientApplicationBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="builder" Type="Microsoft.Identity.Client.PublicClientApplicationBuilder" RefType="this" />
<Parameter Name="enableBroker" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="builder">To be added.</param>
<param name="enableBroker">To be added.</param>
<summary>
Enables MSAL to use Broker flows, which are more secure than browsers.
For details about Windows broker, see https://aka.ms/msal-net-wam
</summary>
<returns>To be added.</returns>
<remarks>
No broker integration exists on Mac and Linux yet.
Windows broker does not work on Win 8, Win Server 2016 and lower.
This implementation is not supported, use <c>WithBroker()</c> from Microsoft.Identity.Client package instead.
If a broker does not exist or cannot be used, MSAL will fallback to a browser.
Make sure browser auth is enabled (e.g. if using system browser, register the "http://localhost" redirect URI, etc.)
</remarks>
</Docs>
</Member>
<Member MemberName="WithSsoPolicy">
<MemberSignature Language="C#" Value="public static Microsoft.Identity.Client.PublicClientApplicationBuilder WithSsoPolicy (this Microsoft.Identity.Client.PublicClientApplicationBuilder builder);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Identity.Client.PublicClientApplicationBuilder WithSsoPolicy(class Microsoft.Identity.Client.PublicClientApplicationBuilder builder) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.Broker.BrokerExtension.WithSsoPolicy(Microsoft.Identity.Client.PublicClientApplicationBuilder)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function WithSsoPolicy (builder As PublicClientApplicationBuilder) As PublicClientApplicationBuilder" />
<MemberSignature Language="F#" Value="static member WithSsoPolicy : Microsoft.Identity.Client.PublicClientApplicationBuilder -> Microsoft.Identity.Client.PublicClientApplicationBuilder" Usage="Microsoft.Identity.Client.Broker.BrokerExtension.WithSsoPolicy builder" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client.Broker</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.PublicClientApplicationBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="builder" Type="Microsoft.Identity.Client.PublicClientApplicationBuilder" RefType="this" />
</Parameters>
<Docs>
<param name="builder" />
<summary>
Use this API to enable SsoPolicy enforcement.
Should only be utilized by Microsoft 1st party applications.
This is applicable only when broker is not enabled and embedded webview is the preferred choice.
By default, the broker supports SsoPolicy, and system webview SsoPolicy is also supported at the OS level.
</summary>
<returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder" /> from which to set more
parameters, and to create a public client application instance</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>