-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
FederationManagement.xml
227 lines (213 loc) · 21.6 KB
/
FederationManagement.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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<Type Name="FederationManagement" FullName="System.IdentityModel.Services.FederationManagement">
<TypeSignature Language="C#" Value="public static class FederationManagement" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit FederationManagement extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Services.FederationManagement" />
<TypeSignature Language="VB.NET" Value="Public Class FederationManagement" />
<TypeSignature Language="F#" Value="type FederationManagement = class" />
<TypeSignature Language="C++ CLI" Value="public ref class FederationManagement abstract sealed" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Defines static methods for creating Federation Metadata documents and for updating application configuration based on Federation Metadata documents.</summary>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="CreateApplicationFederationMetadata">
<MemberSignature Language="C#" Value="public static System.Xml.XmlReader CreateApplicationFederationMetadata (Uri applicationUri, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate, System.Collections.ObjectModel.Collection<System.IdentityModel.Metadata.DisplayClaim> claimsRequired, System.IdentityModel.Services.ApplicationType applicationType, System.Collections.ObjectModel.Collection<Uri> audienceUris);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Xml.XmlReader CreateApplicationFederationMetadata(class System.Uri applicationUri, class System.Security.Cryptography.X509Certificates.X509Certificate2 certificate, class System.Collections.ObjectModel.Collection`1<class System.IdentityModel.Metadata.DisplayClaim> claimsRequired, valuetype System.IdentityModel.Services.ApplicationType applicationType, class System.Collections.ObjectModel.Collection`1<class System.Uri> audienceUris) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.FederationManagement.CreateApplicationFederationMetadata(System.Uri,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Collections.ObjectModel.Collection{System.IdentityModel.Metadata.DisplayClaim},System.IdentityModel.Services.ApplicationType,System.Collections.ObjectModel.Collection{System.Uri})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateApplicationFederationMetadata (applicationUri As Uri, certificate As X509Certificate2, claimsRequired As Collection(Of DisplayClaim), applicationType As ApplicationType, audienceUris As Collection(Of Uri)) As XmlReader" />
<MemberSignature Language="F#" Value="static member CreateApplicationFederationMetadata : Uri * System.Security.Cryptography.X509Certificates.X509Certificate2 * System.Collections.ObjectModel.Collection<System.IdentityModel.Metadata.DisplayClaim> * System.IdentityModel.Services.ApplicationType * System.Collections.ObjectModel.Collection<Uri> -> System.Xml.XmlReader" Usage="System.IdentityModel.Services.FederationManagement.CreateApplicationFederationMetadata (applicationUri, certificate, claimsRequired, applicationType, audienceUris)" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::Xml::XmlReader ^ CreateApplicationFederationMetadata(Uri ^ applicationUri, System::Security::Cryptography::X509Certificates::X509Certificate2 ^ certificate, System::Collections::ObjectModel::Collection<System::IdentityModel::Metadata::DisplayClaim ^> ^ claimsRequired, System::IdentityModel::Services::ApplicationType applicationType, System::Collections::ObjectModel::Collection<Uri ^> ^ audienceUris);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Xml.XmlReader</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="applicationUri" Type="System.Uri" />
<Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
<Parameter Name="claimsRequired" Type="System.Collections.ObjectModel.Collection<System.IdentityModel.Metadata.DisplayClaim>" />
<Parameter Name="applicationType" Type="System.IdentityModel.Services.ApplicationType" />
<Parameter Name="audienceUris" Type="System.Collections.ObjectModel.Collection<System.Uri>" />
</Parameters>
<Docs>
<param name="applicationUri">The application URI.</param>
<param name="certificate">The X.509 certificate to use to sign the metadata.</param>
<param name="claimsRequired">The claims required by the application.</param>
<param name="applicationType">One of the <see cref="T:System.IdentityModel.Services.ApplicationType" /> values that specifies the type of application that the metadata describes. This is used to determine the endpoints to create.</param>
<param name="audienceUris">The collection of acceptable URIs that can be used for this application.</param>
<summary>Creates an XML document that contains Federation Metadata.</summary>
<returns>An XML reader that contains the metadata document that was created by using the parameters.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="UpdateIdentityProviderTrustInfo">
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Updates the specified application configuration, if needed, based on the specified Federation Metadata document.</summary>
</Docs>
</MemberGroup>
<Member MemberName="UpdateIdentityProviderTrustInfo">
<MemberSignature Language="C#" Value="public static System.Xml.XmlReader UpdateIdentityProviderTrustInfo (System.Xml.XmlReader metadataReader, System.Xml.XmlReader inputConfiguration, bool claimsOfferedUpdate);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Xml.XmlReader UpdateIdentityProviderTrustInfo(class System.Xml.XmlReader metadataReader, class System.Xml.XmlReader inputConfiguration, bool claimsOfferedUpdate) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.FederationManagement.UpdateIdentityProviderTrustInfo(System.Xml.XmlReader,System.Xml.XmlReader,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function UpdateIdentityProviderTrustInfo (metadataReader As XmlReader, inputConfiguration As XmlReader, claimsOfferedUpdate As Boolean) As XmlReader" />
<MemberSignature Language="F#" Value="static member UpdateIdentityProviderTrustInfo : System.Xml.XmlReader * System.Xml.XmlReader * bool -> System.Xml.XmlReader" Usage="System.IdentityModel.Services.FederationManagement.UpdateIdentityProviderTrustInfo (metadataReader, inputConfiguration, claimsOfferedUpdate)" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::Xml::XmlReader ^ UpdateIdentityProviderTrustInfo(System::Xml::XmlReader ^ metadataReader, System::Xml::XmlReader ^ inputConfiguration, bool claimsOfferedUpdate);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Xml.XmlReader</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataReader" Type="System.Xml.XmlReader" />
<Parameter Name="inputConfiguration" Type="System.Xml.XmlReader" />
<Parameter Name="claimsOfferedUpdate" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="metadataReader">An XML reader that contains the metadata document.</param>
<param name="inputConfiguration">An XML reader that contains the configuration.</param>
<param name="claimsOfferedUpdate">
<see langword="true" /> if the claims offered list should be updated; otherwise, <see langword="false" />.</param>
<summary>Updates the specified application configuration, if needed, based on the specified Federation Metadata document and a value that specifies whether the claims offered list should be updated.</summary>
<returns>An XML reader that contains the updated configuration or <see langword="null" /> if the configuration could not be updated.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="metadataReader" /> is <see langword="null" />.
-or-
<paramref name="inputConfiguration" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="UpdateIdentityProviderTrustInfo">
<MemberSignature Language="C#" Value="public static System.Xml.XmlReader UpdateIdentityProviderTrustInfo (System.Xml.XmlReader metadataReader, System.Xml.XmlReader inputConfiguration, bool claimsOfferedUpdate, System.IdentityModel.Metadata.MetadataSerializer metadataSerializer);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Xml.XmlReader UpdateIdentityProviderTrustInfo(class System.Xml.XmlReader metadataReader, class System.Xml.XmlReader inputConfiguration, bool claimsOfferedUpdate, class System.IdentityModel.Metadata.MetadataSerializer metadataSerializer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.FederationManagement.UpdateIdentityProviderTrustInfo(System.Xml.XmlReader,System.Xml.XmlReader,System.Boolean,System.IdentityModel.Metadata.MetadataSerializer)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function UpdateIdentityProviderTrustInfo (metadataReader As XmlReader, inputConfiguration As XmlReader, claimsOfferedUpdate As Boolean, metadataSerializer As MetadataSerializer) As XmlReader" />
<MemberSignature Language="F#" Value="static member UpdateIdentityProviderTrustInfo : System.Xml.XmlReader * System.Xml.XmlReader * bool * System.IdentityModel.Metadata.MetadataSerializer -> System.Xml.XmlReader" Usage="System.IdentityModel.Services.FederationManagement.UpdateIdentityProviderTrustInfo (metadataReader, inputConfiguration, claimsOfferedUpdate, metadataSerializer)" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::Xml::XmlReader ^ UpdateIdentityProviderTrustInfo(System::Xml::XmlReader ^ metadataReader, System::Xml::XmlReader ^ inputConfiguration, bool claimsOfferedUpdate, System::IdentityModel::Metadata::MetadataSerializer ^ metadataSerializer);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Xml.XmlReader</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataReader" Type="System.Xml.XmlReader" />
<Parameter Name="inputConfiguration" Type="System.Xml.XmlReader" />
<Parameter Name="claimsOfferedUpdate" Type="System.Boolean" />
<Parameter Name="metadataSerializer" Type="System.IdentityModel.Metadata.MetadataSerializer" />
</Parameters>
<Docs>
<param name="metadataReader">An XML reader that contains the metadata document.</param>
<param name="inputConfiguration">An XML reader that contains the configuration.</param>
<param name="claimsOfferedUpdate">
<see langword="true" /> if the claims offered list should be updated; otherwise, <see langword="false" />.</param>
<param name="metadataSerializer">The serializer with which to read the STS metadata.</param>
<summary>Updates the specified application configuration, if needed, based on the specified Federation Metadata document and a value that specifies whether the claims offered list should be updated. The serializer with which to read the security token service (STS) metadata is also specified.</summary>
<returns>An XML reader that contains the updated configuration or <see langword="null" /> if the configuration could not be updated.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="metadataReader" /> is <see langword="null" />.
-or-
<paramref name="inputConfiguration" /> is <see langword="null" />.
-or-
<paramref name="metadataSerializer" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="UpdateIdentityProviderTrustInfo">
<MemberSignature Language="C#" Value="public static void UpdateIdentityProviderTrustInfo (System.Xml.XmlReader metadataReader, System.Xml.XmlReader inputConfiguration, out System.Xml.XmlNodeReader newIssuerNameRegistry, out System.Xml.XmlNodeReader claimTypesOffered);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void UpdateIdentityProviderTrustInfo(class System.Xml.XmlReader metadataReader, class System.Xml.XmlReader inputConfiguration, [out] class System.Xml.XmlNodeReader& newIssuerNameRegistry, [out] class System.Xml.XmlNodeReader& claimTypesOffered) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.FederationManagement.UpdateIdentityProviderTrustInfo(System.Xml.XmlReader,System.Xml.XmlReader,System.Xml.XmlNodeReader@,System.Xml.XmlNodeReader@)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub UpdateIdentityProviderTrustInfo (metadataReader As XmlReader, inputConfiguration As XmlReader, ByRef newIssuerNameRegistry As XmlNodeReader, ByRef claimTypesOffered As XmlNodeReader)" />
<MemberSignature Language="F#" Value="static member UpdateIdentityProviderTrustInfo : System.Xml.XmlReader * System.Xml.XmlReader * XmlNodeReader * XmlNodeReader -> unit" Usage="System.IdentityModel.Services.FederationManagement.UpdateIdentityProviderTrustInfo (metadataReader, inputConfiguration, newIssuerNameRegistry, claimTypesOffered)" />
<MemberSignature Language="C++ CLI" Value="public:
 static void UpdateIdentityProviderTrustInfo(System::Xml::XmlReader ^ metadataReader, System::Xml::XmlReader ^ inputConfiguration, [Runtime::InteropServices::Out] System::Xml::XmlNodeReader ^ % newIssuerNameRegistry, [Runtime::InteropServices::Out] System::Xml::XmlNodeReader ^ % claimTypesOffered);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataReader" Type="System.Xml.XmlReader" />
<Parameter Name="inputConfiguration" Type="System.Xml.XmlReader" />
<Parameter Name="newIssuerNameRegistry" Type="System.Xml.XmlNodeReader" RefType="out" />
<Parameter Name="claimTypesOffered" Type="System.Xml.XmlNodeReader" RefType="out" />
</Parameters>
<Docs>
<param name="metadataReader">An XML reader that contains the metadata document.</param>
<param name="inputConfiguration">An XML reader that contains the configuration.</param>
<param name="newIssuerNameRegistry">When this method returns, contains an XML node reader that contains the elements that specify the issuer name registry. <see langword="null" /> if there are is no issuer name registry specified. This parameter is treated as uninitialized.</param>
<param name="claimTypesOffered">When this method returns, if the list of claim types offered has been changed, contains an XML node reader that contains elements that specify new list. If the list has not been changed, returns <see langword="null" />. This parameter is treated as uninitialized.</param>
<summary>Updates the specified application configuration, if needed, based on the specified Federation Metadata document. Returns the configuration elements for the issuer name registry, as well as the configuration elements for the updated list of claims types offered, if it has been updated.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="metadataReader" /> is <see langword="null" />.
-or-
<paramref name="inputConfiguration" /><paramref name="metadataReader" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="UpdateIdentityProviderTrustInfo">
<MemberSignature Language="C#" Value="public static void UpdateIdentityProviderTrustInfo (System.Xml.XmlReader metadataReader, System.Xml.XmlReader inputConfiguration, out System.Xml.XmlNodeReader newIssuerNameRegistry, out System.Xml.XmlNodeReader claimTypesOffered, System.IdentityModel.Metadata.MetadataSerializer metadataSerializer);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void UpdateIdentityProviderTrustInfo(class System.Xml.XmlReader metadataReader, class System.Xml.XmlReader inputConfiguration, [out] class System.Xml.XmlNodeReader& newIssuerNameRegistry, [out] class System.Xml.XmlNodeReader& claimTypesOffered, class System.IdentityModel.Metadata.MetadataSerializer metadataSerializer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.FederationManagement.UpdateIdentityProviderTrustInfo(System.Xml.XmlReader,System.Xml.XmlReader,System.Xml.XmlNodeReader@,System.Xml.XmlNodeReader@,System.IdentityModel.Metadata.MetadataSerializer)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub UpdateIdentityProviderTrustInfo (metadataReader As XmlReader, inputConfiguration As XmlReader, ByRef newIssuerNameRegistry As XmlNodeReader, ByRef claimTypesOffered As XmlNodeReader, metadataSerializer As MetadataSerializer)" />
<MemberSignature Language="F#" Value="static member UpdateIdentityProviderTrustInfo : System.Xml.XmlReader * System.Xml.XmlReader * XmlNodeReader * XmlNodeReader * System.IdentityModel.Metadata.MetadataSerializer -> unit" Usage="System.IdentityModel.Services.FederationManagement.UpdateIdentityProviderTrustInfo (metadataReader, inputConfiguration, newIssuerNameRegistry, claimTypesOffered, metadataSerializer)" />
<MemberSignature Language="C++ CLI" Value="public:
 static void UpdateIdentityProviderTrustInfo(System::Xml::XmlReader ^ metadataReader, System::Xml::XmlReader ^ inputConfiguration, [Runtime::InteropServices::Out] System::Xml::XmlNodeReader ^ % newIssuerNameRegistry, [Runtime::InteropServices::Out] System::Xml::XmlNodeReader ^ % claimTypesOffered, System::IdentityModel::Metadata::MetadataSerializer ^ metadataSerializer);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadataReader" Type="System.Xml.XmlReader" />
<Parameter Name="inputConfiguration" Type="System.Xml.XmlReader" />
<Parameter Name="newIssuerNameRegistry" Type="System.Xml.XmlNodeReader" RefType="out" />
<Parameter Name="claimTypesOffered" Type="System.Xml.XmlNodeReader" RefType="out" />
<Parameter Name="metadataSerializer" Type="System.IdentityModel.Metadata.MetadataSerializer" />
</Parameters>
<Docs>
<param name="metadataReader">An XML reader that contains the metadata document.</param>
<param name="inputConfiguration">An XML reader that contains the configuration.</param>
<param name="newIssuerNameRegistry">When this method returns, contains an XML node reader that contains the elements that specify the issuer name registry. <see langword="null" /> if there are is no issuer name registry specified. This parameter is treated as uninitialized.</param>
<param name="claimTypesOffered">When this method returns, if the list of claim types offered has been changed, contains an XML node reader that contains elements that specify new list. If the list has not been changed, returns <see langword="null" />. This parameter is treated as uninitialized.</param>
<param name="metadataSerializer">The serializer with which to read the STS metadata.</param>
<summary>Updates the specified application configuration, if needed, based on the specified Federation Metadata document. Returns configuration elements for the issuer name registry, as well as the configuration elements for the updated list of claims types offered, if it has been updated. The serializer with which to read the security token service (STS) metadata is also specified.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="metadataReader" /> is <see langword="null" />.
-or-
<paramref name="inputConfiguration" /> is <see langword="null" />.
-or-
<paramref name="metadataSerializer" /> is <see langword="null" />.</exception>
</Docs>
</Member>
</Members>
</Type>