forked from dotnet/dotnet-api-docs
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathSecurityTokenRequirement.xml
More file actions
666 lines (626 loc) · 42.3 KB
/
Copy pathSecurityTokenRequirement.xml
File metadata and controls
666 lines (626 loc) · 42.3 KB
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
<Type Name="SecurityTokenRequirement" FullName="System.IdentityModel.Selectors.SecurityTokenRequirement">
<TypeSignature Language="C#" Value="public class SecurityTokenRequirement" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SecurityTokenRequirement extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Selectors.SecurityTokenRequirement" />
<TypeSignature Language="VB.NET" Value="Public Class SecurityTokenRequirement" />
<TypeSignature Language="F#" Value="type SecurityTokenRequirement = class" />
<TypeSignature Language="C++ CLI" Value="public ref class SecurityTokenRequirement" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.7.0.0</AssemblyVersion>
<AssemblyVersion>4.9.0.0</AssemblyVersion>
<AssemblyVersion>4.10.0.0</AssemblyVersion>
<AssemblyVersion>4.10.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>8.1.0.0</AssemblyVersion>
<AssemblyVersion>8.1.1.0</AssemblyVersion>
<AssemblyVersion>8.1.2.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="System.ServiceModel.Primitives" FromVersion="10.0.0.0" To="System.IdentityModel" ToVersion="4.0.0.0" FrameworkAlternate="netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Specifies security token requirements.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Application code typically does not need to use the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement> class, unless a custom security token, security token manager, security token provider, or security token authenticator are created. The <xref:System.IdentityModel.Selectors.SecurityTokenRequirement> class is used by a security token manager to specify what is required of a security token, such as the key size, key type, and how the key can be used. When a security token can be identified that matches the specified criteria, a <xref:System.IdentityModel.Selectors.SecurityTokenProvider> and <xref:System.IdentityModel.Selectors.SecurityTokenAuthenticator> can be obtained to provide security tokens for outgoing SOAP messages and to authenticate security tokens for incoming SOAP messages, respectively. For example, the default security token manager for outgoing SOAP messages has the <xref:System.ServiceModel.ClientCredentialsSecurityTokenManager.CreateSecurityTokenProvider(System.IdentityModel.Selectors.SecurityTokenRequirement)> method that takes a <xref:System.IdentityModel.Selectors.SecurityTokenRequirement> parameter that can be called to obtain a security token provider that matches the criteria specified in the security token requirement.
## Examples
<xref:System.ServiceModel.ClientCredentialsSecurityTokenManager>
<xref:System.ServiceModel.Security.ServiceCredentialsSecurityTokenManager>
<xref:System.IdentityModel.Selectors.SecurityTokenProvider>
<xref:System.IdentityModel.Selectors.SecurityTokenAuthenticator>
<xref:System.ServiceModel.ClientCredentialsSecurityTokenManager.CreateSecurityTokenAuthenticator(System.IdentityModel.Selectors.SecurityTokenRequirement,System.IdentityModel.Selectors.SecurityTokenResolver@)>
<xref:System.ServiceModel.ClientCredentialsSecurityTokenManager.CreateSecurityTokenProvider(System.IdentityModel.Selectors.SecurityTokenRequirement)>
<xref:System.ServiceModel.Security.ServiceCredentialsSecurityTokenManager.CreateSecurityTokenAuthenticator(System.IdentityModel.Selectors.SecurityTokenRequirement,System.IdentityModel.Selectors.SecurityTokenResolver@)>
<xref:System.ServiceModel.Security.ServiceCredentialsSecurityTokenManager.CreateSecurityTokenProvider(System.IdentityModel.Selectors.SecurityTokenRequirement)>
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SecurityTokenRequirement ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Selectors.SecurityTokenRequirement.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 SecurityTokenRequirement();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Selectors.SecurityTokenRequirement" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetProperty<TValue>">
<MemberSignature Language="C#" Value="public TValue GetProperty<TValue> (string propertyName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!TValue GetProperty<TValue>(string propertyName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Selectors.SecurityTokenRequirement.GetProperty``1(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetProperty(Of TValue) (propertyName As String) As TValue" />
<MemberSignature Language="F#" Value="member this.GetProperty : string -> 'Value" Usage="securityTokenRequirement.GetProperty propertyName" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TValue>
 TValue GetProperty(System::String ^ propertyName);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TValue</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TValue" />
</TypeParameters>
<Parameters>
<Parameter Name="propertyName" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TValue">The type of the property to get.</typeparam>
<param name="propertyName">The name of the property to get.</param>
<summary>Gets the specified property for the current <see cref="T:System.IdentityModel.Selectors.SecurityTokenRequirement" /> instance.</summary>
<returns>The value of the property to get.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.GetProperty*> method first calls the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.TryGetProperty``1(System.String,``0@)> method to determine if the property specified in the `propertyName` parameter has been set. Secondly, the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.GetProperty*> method verifies that when a property value is returned that it can be set to the type specified in the `TValue` parameter.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="propertyName" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="IsOptionalTokenProperty">
<MemberSignature Language="C#" Value="public static string IsOptionalTokenProperty { get; }" />
<MemberSignature Language="ILAsm" Value=".property string IsOptionalTokenProperty" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.IsOptionalTokenProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property IsOptionalTokenProperty As String" />
<MemberSignature Language="F#" Value="static member IsOptionalTokenProperty : string" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.IsOptionalTokenProperty" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::String ^ IsOptionalTokenProperty { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value of the token property if it is optional.</summary>
<value>A value of the token property.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="KeySize">
<MemberSignature Language="C#" Value="public int KeySize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 KeySize" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeySize" />
<MemberSignature Language="VB.NET" Value="Public Property KeySize As Integer" />
<MemberSignature Language="F#" Value="member this.KeySize : int with get, set" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.KeySize" />
<MemberSignature Language="C++ CLI" Value="public:
 property int KeySize { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the required size of the key associated with a security token.</summary>
<value>The size of the key, in bits, associated with a security token. The default value is 0.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeySize> property can also be accessed by getting the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties> property, which is a collection of property values. The value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeySize> property is stored at the index matching the value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeySizeProperty> property.
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeySize" /> property is set to a value less than 0.</exception>
</Docs>
</Member>
<Member MemberName="KeySizeProperty">
<MemberSignature Language="C#" Value="public static string KeySizeProperty { get; }" />
<MemberSignature Language="ILAsm" Value=".property string KeySizeProperty" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeySizeProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property KeySizeProperty As String" />
<MemberSignature Language="F#" Value="static member KeySizeProperty : string" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.KeySizeProperty" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::String ^ KeySizeProperty { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that specifies the name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeySize" /> property.</summary>
<value>The name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeySize" /> property.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To set the required key size, use the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeySize> property.
]]></format>
</remarks>
<altmember cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeySize" />
</Docs>
</Member>
<Member MemberName="KeyType">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.SecurityKeyType KeyType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.IdentityModel.Tokens.SecurityKeyType KeyType" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyType" />
<MemberSignature Language="VB.NET" Value="Public Property KeyType As SecurityKeyType" />
<MemberSignature Language="F#" Value="member this.KeyType : System.IdentityModel.Tokens.SecurityKeyType with get, set" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.KeyType" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::SecurityKeyType KeyType { System::IdentityModel::Tokens::SecurityKeyType get(); void set(System::IdentityModel::Tokens::SecurityKeyType value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityKeyType</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the type of key (asymmetric or symmetric) associated with a security token.</summary>
<value>A <see cref="T:System.IdentityModel.Tokens.SecurityKeyType" /> that specifies the type of key (asymmetric or symmetric) associated with a security token. The default value is <see langword="SymmetricKey" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyType> property can also be accessed by getting the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties> property, which is a collection of property values. The value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyType> property is stored at the index matching the value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyTypeProperty> property.
]]></format>
</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityKeyType" />
</Docs>
</Member>
<Member MemberName="KeyTypeProperty">
<MemberSignature Language="C#" Value="public static string KeyTypeProperty { get; }" />
<MemberSignature Language="ILAsm" Value=".property string KeyTypeProperty" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyTypeProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property KeyTypeProperty As String" />
<MemberSignature Language="F#" Value="static member KeyTypeProperty : string" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.KeyTypeProperty" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::String ^ KeyTypeProperty { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that specifies the name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyType" /> property.</summary>
<value>The name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyType" /> property.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To set the required key type, use the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyType> property.
]]></format>
</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityKeyType" />
<altmember cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyType" />
</Docs>
</Member>
<Member MemberName="KeyUsage">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.SecurityKeyUsage KeyUsage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.IdentityModel.Tokens.SecurityKeyUsage KeyUsage" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyUsage" />
<MemberSignature Language="VB.NET" Value="Public Property KeyUsage As SecurityKeyUsage" />
<MemberSignature Language="F#" Value="member this.KeyUsage : System.IdentityModel.Tokens.SecurityKeyUsage with get, set" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.KeyUsage" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::SecurityKeyUsage KeyUsage { System::IdentityModel::Tokens::SecurityKeyUsage get(); void set(System::IdentityModel::Tokens::SecurityKeyUsage value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityKeyUsage</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that specifies how the key associated with a security token can be used.</summary>
<value>A <see cref="T:System.IdentityModel.Tokens.SecurityKeyUsage" /> that specifies how the key associated with a security token can be used. The default value is <see cref="F:System.IdentityModel.Tokens.SecurityKeyUsage.Signature" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyUsage> property can also be accessed by getting the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties> property, which is a collection of property values. The value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyUsage> property is stored at the index matching the value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyUsageProperty> property.
]]></format>
</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityKeyUsage" />
</Docs>
</Member>
<Member MemberName="KeyUsageProperty">
<MemberSignature Language="C#" Value="public static string KeyUsageProperty { get; }" />
<MemberSignature Language="ILAsm" Value=".property string KeyUsageProperty" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyUsageProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property KeyUsageProperty As String" />
<MemberSignature Language="F#" Value="static member KeyUsageProperty : string" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.KeyUsageProperty" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::String ^ KeyUsageProperty { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that specifies the name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyUsage" /> property.</summary>
<value>The name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyUsage" /> property.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To set the key usage requirement, use the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyUsage> property.
]]></format>
</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityKeyUsage" />
</Docs>
</Member>
<Member MemberName="PeerAuthenticationMode">
<MemberSignature Language="C#" Value="public static string PeerAuthenticationMode { get; }" />
<MemberSignature Language="ILAsm" Value=".property string PeerAuthenticationMode" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.PeerAuthenticationMode" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property PeerAuthenticationMode As String" />
<MemberSignature Language="F#" Value="static member PeerAuthenticationMode : string" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.PeerAuthenticationMode" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::String ^ PeerAuthenticationMode { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for a property that specifies the peer authentication method.</summary>
<value>The name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for a property that specifies the peer authentication method.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To add the capability to set the peer authentication mode, derive a class from <xref:System.IdentityModel.Selectors.SecurityTokenRequirement> and expose a property or constructor. Within the constructor or property add the peer authentication mode to the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties> collection using the value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.PeerAuthenticationMode> property as an index into the collection.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,object> Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, object> Properties" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Properties As IDictionary(Of String, Object)" />
<MemberSignature Language="F#" Value="member this.Properties : System.Collections.Generic.IDictionary<string, obj>" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IDictionary<System::String ^, System::Object ^> ^ Properties { System::Collections::Generic::IDictionary<System::String ^, System::Object ^> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.Object></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a collection of the non-static properties for the current <see cref="T:System.IdentityModel.Selectors.SecurityTokenRequirement" /> instance.</summary>
<value>An <see cref="T:System.Collections.Generic.IDictionary`2" /> that contains a collection of the non-static properties for the current <see cref="T:System.IdentityModel.Selectors.SecurityTokenRequirement" /> instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the values of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeySizeProperty>, <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyTypeProperty>, <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.KeyUsageProperty>, <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.TokenTypeProperty> properties as indexes into the collection to get a specific property value.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="RequireCryptographicToken">
<MemberSignature Language="C#" Value="public bool RequireCryptographicToken { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool RequireCryptographicToken" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.RequireCryptographicToken" />
<MemberSignature Language="VB.NET" Value="Public Property RequireCryptographicToken As Boolean" />
<MemberSignature Language="F#" Value="member this.RequireCryptographicToken : bool with get, set" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.RequireCryptographicToken" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool RequireCryptographicToken { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether the security token must be capable of performing cryptographic operations, such as encryption.</summary>
<value>
<see langword="true" /> if the security token must be capable of performing cryptographic operations; otherwise, <see langword="false" />. The default is <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Some security tokens, such as the <xref:System.IdentityModel.Tokens.UserNameSecurityToken>, are not secure enough to perform cryptographic operations and should only be used for authentication.
The value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.RequireCryptographicToken> property can also be accessed by getting the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties> property, which is a collection of property values. The value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.RequireCryptographicToken> property is stored at the index matching the value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.RequireCryptographicTokenProperty> property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="RequireCryptographicTokenProperty">
<MemberSignature Language="C#" Value="public static string RequireCryptographicTokenProperty { get; }" />
<MemberSignature Language="ILAsm" Value=".property string RequireCryptographicTokenProperty" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.RequireCryptographicTokenProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property RequireCryptographicTokenProperty As String" />
<MemberSignature Language="F#" Value="static member RequireCryptographicTokenProperty : string" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.RequireCryptographicTokenProperty" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::String ^ RequireCryptographicTokenProperty { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.RequireCryptographicToken" /> property.</summary>
<value>The name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.RequireCryptographicToken" /> property.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TokenType">
<MemberSignature Language="C#" Value="public string TokenType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TokenType" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.TokenType" />
<MemberSignature Language="VB.NET" Value="Public Property TokenType As String" />
<MemberSignature Language="F#" Value="member this.TokenType : string with get, set" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.TokenType" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ TokenType { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the required security token type.</summary>
<value>The required security token type.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use one of the static properties of the <xref:System.IdentityModel.Tokens.SecurityTokenTypes> class to set this property.
The value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.TokenType> property can also be accessed by getting the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties> property, which is a collection of property values. The value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.TokenType> property is stored at the index matching the value of the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.TokenTypeProperty> property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="TokenTypeProperty">
<MemberSignature Language="C#" Value="public static string TokenTypeProperty { get; }" />
<MemberSignature Language="ILAsm" Value=".property string TokenTypeProperty" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Selectors.SecurityTokenRequirement.TokenTypeProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property TokenTypeProperty As String" />
<MemberSignature Language="F#" Value="static member TokenTypeProperty : string" Usage="System.IdentityModel.Selectors.SecurityTokenRequirement.TokenTypeProperty" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::String ^ TokenTypeProperty { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that specifies the name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.TokenType" /> property.</summary>
<value>The name of the index in the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> collection for the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.TokenType" /> property.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To set the required security token type, use the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.TokenType> property.
]]></format>
</remarks>
<altmember cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.TokenType" />
</Docs>
</Member>
<Member MemberName="TryGetProperty<TValue>">
<MemberSignature Language="C#" Value="public bool TryGetProperty<TValue> (string propertyName, out TValue result);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetProperty<TValue>(string propertyName, [out] !!TValue& result) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Selectors.SecurityTokenRequirement.TryGetProperty``1(System.String,``0@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetProperty(Of TValue) (propertyName As String, ByRef result As TValue) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetProperty : string * 'Value -> bool" Usage="securityTokenRequirement.TryGetProperty (propertyName, result)" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TValue>
 bool TryGetProperty(System::String ^ propertyName, [Runtime::InteropServices::Out] TValue % result);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TValue" />
</TypeParameters>
<Parameters>
<Parameter Name="propertyName" Type="System.String" />
<Parameter Name="result" Type="TValue" RefType="out" />
</Parameters>
<Docs>
<typeparam name="TValue">The type of property to return in the <paramref name="result" /> parameter.</typeparam>
<param name="propertyName">The name of the property to get.</param>
<param name="result">The value of the property specified in the <paramref name="propertyName" /> property.</param>
<summary>Gets the specified property for the current <see cref="T:System.IdentityModel.Selectors.SecurityTokenRequirement" /> instance.</summary>
<returns>
<see langword="true" /> if the <see cref="P:System.IdentityModel.Selectors.SecurityTokenRequirement.Properties" /> property contains a property value for the property specified in the <paramref name="propertyName" /> property; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To get the property value of the specified property and verify that property value can be set to the type specified in the `TValue` parameter, call the <xref:System.IdentityModel.Selectors.SecurityTokenRequirement.GetProperty``1(System.String)> method.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">A properties exists with the name specified in the <paramref name="propertyName" /> parameter, but it is not of the same type that is specified in the <paramref name="TValue" /> parameter.</exception>
</Docs>
</Member>
</Members>
</Type>