-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
RequestSecurityToken.xml
628 lines (575 loc) · 42.8 KB
/
RequestSecurityToken.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
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
<Type Name="RequestSecurityToken" FullName="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken">
<TypeSignature Language="C#" Value="public class RequestSecurityToken : System.IdentityModel.Protocols.WSTrust.WSTrustMessage" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RequestSecurityToken extends System.IdentityModel.Protocols.WSTrust.WSTrustMessage" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken" />
<TypeSignature Language="VB.NET" Value="Public Class RequestSecurityToken
Inherits WSTrustMessage" />
<TypeSignature Language="F#" Value="type RequestSecurityToken = class
 inherit WSTrustMessage" />
<TypeSignature Language="C++ CLI" Value="public ref class RequestSecurityToken : System::IdentityModel::Protocols::WSTrust::WSTrustMessage" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.IdentityModel.Protocols.WSTrust.WSTrustMessage</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents the wst:RequestSecurityToken element (RST), which is used to request a security token.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The wst:RequestSecurityToken element (message) contains the parameters and properties used to request a security token from a security token service (STS). The message (or element) is abbreviated as RST. The <xref:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken> class contains properties that represent the elements of the RST. An RST can form a request that corresponds to any of the request bindings defined by WS-Trust; for example, the Issuance binding, the Renewal binding, the Validate binding, or the Cancel binding. Many of the properties in the <xref:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken> class correspond to elements that are present only in specific kinds of requests as defined by these bindings. Depending on the kind of request a particular <xref:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken> object represents or the parameters present in the specific request that it represents, some properties of the object may be `null`.
The STS returns a response to the request in a message that contains a wst:RequestSecurityTokenResponse element (RSTR). This message is represented by the <xref:System.IdentityModel.Protocols.WSTrust.RequestSecurityTokenResponse> class.
[!INCLUDE[wif_wstrust_ref](~/includes/wif-wstrust-ref-md.md)]
## Examples
The code example that is used in this topic is taken from the `Custom Token` sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT) and it includes an implementation of a passive STS that is capable of serving an SWT token. The STS is implemented by a class that is derived from <xref:System.IdentityModel.SecurityTokenService>. Many of the methods of the <xref:System.IdentityModel.SecurityTokenService> class that are called from its token issuance pipeline take a <xref:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken> object as one if their parameters. For information about this sample and other samples available for WIF and about where to download them, see [WIF Code Sample Index](/previous-versions/dotnet/framework/windows-identity-foundation/wif-code-sample-index).
The following code example shows an implementation of the <xref:System.IdentityModel.SecurityTokenService.GetScope%2A?displayProperty=nameWithType> method. The method takes a <xref:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken> as one of its parameters and properties of this parameter are used to set properties on the <xref:System.IdentityModel.Scope> object that is returned by the method.
:::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/customsecuritytokenservice.cs" id="Snippet4":::
:::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/customsecuritytokenservice.cs" id="Snippet5":::
:::code language="csharp" source="~/snippets/csharp/System.IdentityModel/SecurityTokenService/Overview/customsecuritytokenservice.cs" id="Snippet7":::
]]></format>
</remarks>
<altmember cref="T:System.IdentityModel.SecurityTokenService" />
<altmember cref="T:System.IdentityModel.Protocols.WSTrust.RequestedSecurityToken" />
<altmember cref="T:System.IdentityModel.Protocols.WSTrust.RequestSecurityTokenResponse" />
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RequestSecurityToken ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 RequestSecurityToken();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.IdentityModel.Protocols.WSTrust.WSTrustMessage.RequestType%2A> property and <xref:System.IdentityModel.Protocols.WSTrust.WSTrustMessage.KeyType%2A> property are initialized to `null`.
This constructor is usually used by the receiver.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RequestSecurityToken (string requestType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string requestType) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (requestType As String)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Protocols.WSTrust.RequestSecurityToken : string -> System.IdentityModel.Protocols.WSTrust.RequestSecurityToken" Usage="new System.IdentityModel.Protocols.WSTrust.RequestSecurityToken requestType" />
<MemberSignature Language="C++ CLI" Value="public:
 RequestSecurityToken(System::String ^ requestType);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="requestType" Type="System.String" />
</Parameters>
<Docs>
<param name="requestType">A string that contains the request type URI.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken" /> class with the specified request type.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.IdentityModel.Protocols.WSTrust.WSTrustMessage.KeyType%2A> property is initialized to `null`.
This constructor is usually used by the sender.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RequestSecurityToken (string requestType, string keyType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string requestType, string keyType) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (requestType As String, keyType As String)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Protocols.WSTrust.RequestSecurityToken : string * string -> System.IdentityModel.Protocols.WSTrust.RequestSecurityToken" Usage="new System.IdentityModel.Protocols.WSTrust.RequestSecurityToken (requestType, keyType)" />
<MemberSignature Language="C++ CLI" Value="public:
 RequestSecurityToken(System::String ^ requestType, System::String ^ keyType);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="requestType" Type="System.String" />
<Parameter Name="keyType" Type="System.String" />
</Parameters>
<Docs>
<param name="requestType">A string that contains the request type URI.</param>
<param name="keyType">A string that contains the key type URI. This should be one of the constants defined by the <see cref="T:System.IdentityModel.Protocols.WSTrust.KeyTypes" /> class.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken" /> class with the specified request type.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows the initial value of the <xref:System.IdentityModel.Protocols.WSTrust.WSTrustMessage.KeySizeInBits%2A> property for specific values of the `keyType` parameter.
|`keyType` parameter|<xref:System.IdentityModel.Protocols.WSTrust.WSTrustMessage.KeySizeInBits%2A> property|
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|<xref:System.IdentityModel.Protocols.WSTrust.KeyTypes.Asymmetric>|1024|
|<xref:System.IdentityModel.Protocols.WSTrust.KeyTypes.Bearer>|0|
|<xref:System.IdentityModel.Protocols.WSTrust.KeyTypes.Symmetric>|256|
This constructor is usually used by the sender.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ActAs">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.SecurityTokenElement ActAs { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.SecurityTokenElement ActAs" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.ActAs" />
<MemberSignature Language="VB.NET" Value="Public Property ActAs As SecurityTokenElement" />
<MemberSignature Language="F#" Value="member this.ActAs : System.IdentityModel.Tokens.SecurityTokenElement with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.ActAs" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::SecurityTokenElement ^ ActAs { System::IdentityModel::Tokens::SecurityTokenElement ^ get(); void set(System::IdentityModel::Tokens::SecurityTokenElement ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityTokenElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the security token for the identity that the requestor is attempting to act as.</summary>
<value>A <see cref="T:System.IdentityModel.Tokens.SecurityTokenElement" /> that represents the identity the requestor is attempting to act as. Can be <see langword="null" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the wst:ActAs element. This optional element supports delegation scenarios and indicates that the requestor is making the request to act as another identity. This element is introduced in WS-Trust 1.4. This property is `null` in requests that don't involve delegation.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="AdditionalContext">
<MemberSignature Language="C#" Value="public System.IdentityModel.Protocols.WSTrust.AdditionalContext AdditionalContext { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Protocols.WSTrust.AdditionalContext AdditionalContext" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.AdditionalContext" />
<MemberSignature Language="VB.NET" Value="Public Property AdditionalContext As AdditionalContext" />
<MemberSignature Language="F#" Value="member this.AdditionalContext : System.IdentityModel.Protocols.WSTrust.AdditionalContext with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.AdditionalContext" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Protocols::WSTrust::AdditionalContext ^ AdditionalContext { System::IdentityModel::Protocols::WSTrust::AdditionalContext ^ get(); void set(System::IdentityModel::Protocols::WSTrust::AdditionalContext ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Protocols.WSTrust.AdditionalContext</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the additional context information for the request.</summary>
<value>An <see cref="T:System.IdentityModel.Protocols.WSTrust.AdditionalContext" /> that contains the additional context information for the request. Can be <see langword="null" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the auth:AdditionalContext element. This optional element provides additional information that the security token service (STS) can use in the token issuance process.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CancelTarget">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.SecurityTokenElement CancelTarget { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.SecurityTokenElement CancelTarget" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.CancelTarget" />
<MemberSignature Language="VB.NET" Value="Public Property CancelTarget As SecurityTokenElement" />
<MemberSignature Language="F#" Value="member this.CancelTarget : System.IdentityModel.Tokens.SecurityTokenElement with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.CancelTarget" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::SecurityTokenElement ^ CancelTarget { System::IdentityModel::Tokens::SecurityTokenElement ^ get(); void set(System::IdentityModel::Tokens::SecurityTokenElement ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityTokenElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the token to be canceled in a WS-Trust cancel request.</summary>
<value>A <see cref="T:System.IdentityModel.Tokens.SecurityTokenElement" /> that contains the token to be cancelled.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of a wst:CancelTarget element. This element carries the information about the token to be cancelled in a WS-Trust cancel request.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Claims">
<MemberSignature Language="C#" Value="public System.IdentityModel.Protocols.WSTrust.RequestClaimCollection Claims { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Protocols.WSTrust.RequestClaimCollection Claims" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Claims" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Claims As RequestClaimCollection" />
<MemberSignature Language="F#" Value="member this.Claims : System.IdentityModel.Protocols.WSTrust.RequestClaimCollection" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Claims" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Protocols::WSTrust::RequestClaimCollection ^ Claims { System::IdentityModel::Protocols::WSTrust::RequestClaimCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Protocols.WSTrust.RequestClaimCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the claim types requested by the client (requestor).</summary>
<value>A <see cref="T:System.IdentityModel.Protocols.WSTrust.RequestClaimCollection" /> that contains the requested claims. The default is an empty collection.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the wst:Claims element. This optional element requests the set of specific claim types requested by the client.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ComputedKeyAlgorithm">
<MemberSignature Language="C#" Value="public string ComputedKeyAlgorithm { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ComputedKeyAlgorithm" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.ComputedKeyAlgorithm" />
<MemberSignature Language="VB.NET" Value="Public Property ComputedKeyAlgorithm As String" />
<MemberSignature Language="F#" Value="member this.ComputedKeyAlgorithm : string with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.ComputedKeyAlgorithm" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ComputedKeyAlgorithm { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a URI that represents the desired algorithm to use when computed keys are used for issued tokens.</summary>
<value>A string that contains the URI that represents the computed key algorithm.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the wst:ComputedKeyAlgorithm element. This optional element specifies a URI that represents the desired algorithm to use when computed keys are used for issued tokens.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Delegatable">
<MemberSignature Language="C#" Value="public bool? Delegatable { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> Delegatable" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Delegatable" />
<MemberSignature Language="VB.NET" Value="Public Property Delegatable As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.Delegatable : Nullable<bool> with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Delegatable" />
<MemberSignature Language="C++ CLI" Value="public:
 property Nullable<bool> Delegatable { Nullable<bool> get(); void set(Nullable<bool> value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that specifies if the issued token should be marked as delegatable.</summary>
<value>
<see langword="true" /> if the issued token is delegatable; otherwise, <see langword="false" />. Can be <see langword="null" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the wst:Delegatable element. This optional element indicates that the returned token may be delegatable to another party. This element is introduced in WS-Trust 1.4. This property used in conjunction with the <xref:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.DelegateTo%2A> property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DelegateTo">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.SecurityTokenElement DelegateTo { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.SecurityTokenElement DelegateTo" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.DelegateTo" />
<MemberSignature Language="VB.NET" Value="Public Property DelegateTo As SecurityTokenElement" />
<MemberSignature Language="F#" Value="member this.DelegateTo : System.IdentityModel.Tokens.SecurityTokenElement with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.DelegateTo" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::SecurityTokenElement ^ DelegateTo { System::IdentityModel::Tokens::SecurityTokenElement ^ get(); void set(System::IdentityModel::Tokens::SecurityTokenElement ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityTokenElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the identity to which the issued token should be delegated.</summary>
<value>A <see cref="T:System.IdentityModel.Tokens.SecurityTokenElement" /> that represents the identity to which the issued token should be delegated. Can be <see langword="null" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the wst:DelegateTo element. This optional element indicates that the issued token be delegated to the specified identity. This element is introduced in WS-Trust 1.4. This property is `null` in requests that don't involve delegation. This property is used in conjunction with the <xref:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.DelegateTo%2A> property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Encryption">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.SecurityTokenElement Encryption { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.SecurityTokenElement Encryption" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Encryption" />
<MemberSignature Language="VB.NET" Value="Public Property Encryption As SecurityTokenElement" />
<MemberSignature Language="F#" Value="member this.Encryption : System.IdentityModel.Tokens.SecurityTokenElement with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Encryption" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::SecurityTokenElement ^ Encryption { System::IdentityModel::Tokens::SecurityTokenElement ^ get(); void set(System::IdentityModel::Tokens::SecurityTokenElement ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityTokenElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets information on the token and key to use when encrypting.</summary>
<value>A <see cref="T:System.IdentityModel.Tokens.SecurityTokenElement" /> that contains the encrypting information.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the wst:Encryption element. This optional element indicates that any returned secrets in issued security tokens should be encrypted for the specified token.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Forwardable">
<MemberSignature Language="C#" Value="public bool? Forwardable { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> Forwardable" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Forwardable" />
<MemberSignature Language="VB.NET" Value="Public Property Forwardable As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.Forwardable : Nullable<bool> with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Forwardable" />
<MemberSignature Language="C++ CLI" Value="public:
 property Nullable<bool> Forwardable { Nullable<bool> get(); void set(Nullable<bool> value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that specifies if the issued token should be marked forwardable.</summary>
<value>
<see langword="true" /> if the issued token is forwardable; otherwise, <see langword="false" />. Can be <see langword="null" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the wst:Forwardable element. This optional element indicates whether the returned token is bound to the requestor's computer or service (indicated by a `false` value). This element is introduced in WS-Trust 1.4. This property used in conjunction with the <xref:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.DelegateTo%2A> property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Issuer">
<MemberSignature Language="C#" Value="public System.IdentityModel.Protocols.WSTrust.EndpointReference Issuer { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Protocols.WSTrust.EndpointReference Issuer" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Issuer" />
<MemberSignature Language="VB.NET" Value="Public Property Issuer As EndpointReference" />
<MemberSignature Language="F#" Value="member this.Issuer : System.IdentityModel.Protocols.WSTrust.EndpointReference with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Issuer" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Protocols::WSTrust::EndpointReference ^ Issuer { System::IdentityModel::Protocols::WSTrust::EndpointReference ^ get(); void set(System::IdentityModel::Protocols::WSTrust::EndpointReference ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Protocols.WSTrust.EndpointReference</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the issuer of the wst:OnBehalfOf token.</summary>
<value>A <see cref="T:System.ServiceModel.EndpointAddress" /> that contains the address of the issuer.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the wst:Issuer element. This optional element identifies the issuer of the token that is specified in the wst:OnBehalfOf element.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="OnBehalfOf">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.SecurityTokenElement OnBehalfOf { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.SecurityTokenElement OnBehalfOf" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.OnBehalfOf" />
<MemberSignature Language="VB.NET" Value="Public Property OnBehalfOf As SecurityTokenElement" />
<MemberSignature Language="F#" Value="member this.OnBehalfOf : System.IdentityModel.Tokens.SecurityTokenElement with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.OnBehalfOf" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::SecurityTokenElement ^ OnBehalfOf { System::IdentityModel::Tokens::SecurityTokenElement ^ get(); void set(System::IdentityModel::Tokens::SecurityTokenElement ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityTokenElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the token for the identity on behalf of which the request is being made.</summary>
<value>A <see cref="T:System.IdentityModel.Tokens.SecurityTokenElement" /> that contains the token of the identity for which the request is being made.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the wst:OnBehalfOf element. This optional element indicates that the requestor is making the request on behalf of another identity.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Participants">
<MemberSignature Language="C#" Value="public System.IdentityModel.Protocols.WSTrust.Participants Participants { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Protocols.WSTrust.Participants Participants" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Participants" />
<MemberSignature Language="VB.NET" Value="Public Property Participants As Participants" />
<MemberSignature Language="F#" Value="member this.Participants : System.IdentityModel.Protocols.WSTrust.Participants with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Participants" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Protocols::WSTrust::Participants ^ Participants { System::IdentityModel::Protocols::WSTrust::Participants ^ get(); void set(System::IdentityModel::Protocols::WSTrust::Participants ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Protocols.WSTrust.Participants</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the participants that are authorized to use the issued token.</summary>
<value>A <see cref="T:System.IdentityModel.Protocols.WSTrust.Participants" /> that contains the participants that are authorized to use the issued token.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the wst:Participants element. This optional element identifies additional participants that are authorized to use the token.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ProofEncryption">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.SecurityTokenElement ProofEncryption { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.SecurityTokenElement ProofEncryption" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.ProofEncryption" />
<MemberSignature Language="VB.NET" Value="Public Property ProofEncryption As SecurityTokenElement" />
<MemberSignature Language="F#" Value="member this.ProofEncryption : System.IdentityModel.Tokens.SecurityTokenElement with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.ProofEncryption" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::SecurityTokenElement ^ ProofEncryption { System::IdentityModel::Tokens::SecurityTokenElement ^ get(); void set(System::IdentityModel::Tokens::SecurityTokenElement ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityTokenElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the token to be used to encrypt the proof token.</summary>
<value>A <see cref="T:System.IdentityModel.Tokens.SecurityTokenElement" /> that contains the token.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the wst:ProofEncryption element. This optional element contains the token to be used to encrypt the proof key.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Renewing">
<MemberSignature Language="C#" Value="public System.IdentityModel.Protocols.WSTrust.Renewing Renewing { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Protocols.WSTrust.Renewing Renewing" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Renewing" />
<MemberSignature Language="VB.NET" Value="Public Property Renewing As Renewing" />
<MemberSignature Language="F#" Value="member this.Renewing : System.IdentityModel.Protocols.WSTrust.Renewing with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.Renewing" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Protocols::WSTrust::Renewing ^ Renewing { System::IdentityModel::Protocols::WSTrust::Renewing ^ get(); void set(System::IdentityModel::Protocols::WSTrust::Renewing ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Protocols.WSTrust.Renewing</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the renew semantics for a WS-Trust renew request.</summary>
<value>Returns <see cref="T:System.IdentityModel.Protocols.WSTrust.Renewing" /> that contains the renew semantics.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the wst:Renewing element. This optional element specifies the renew semantics for a WS-Trust renew request.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="RenewTarget">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.SecurityTokenElement RenewTarget { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.SecurityTokenElement RenewTarget" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.RenewTarget" />
<MemberSignature Language="VB.NET" Value="Public Property RenewTarget As SecurityTokenElement" />
<MemberSignature Language="F#" Value="member this.RenewTarget : System.IdentityModel.Tokens.SecurityTokenElement with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.RenewTarget" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::SecurityTokenElement ^ RenewTarget { System::IdentityModel::Tokens::SecurityTokenElement ^ get(); void set(System::IdentityModel::Tokens::SecurityTokenElement ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityTokenElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the token to be renewed in a WS-Trust renew request.</summary>
<value>A <see cref="T:System.IdentityModel.Tokens.SecurityTokenElement" /> that contains the token to be renewed.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of a wst:RenewTarget element. This element carries the information about the token to be renewed in a WS-Trust renew request.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SecondaryParameters">
<MemberSignature Language="C#" Value="public System.IdentityModel.Protocols.WSTrust.RequestSecurityToken SecondaryParameters { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Protocols.WSTrust.RequestSecurityToken SecondaryParameters" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.SecondaryParameters" />
<MemberSignature Language="VB.NET" Value="Public Property SecondaryParameters As RequestSecurityToken" />
<MemberSignature Language="F#" Value="member this.SecondaryParameters : System.IdentityModel.Protocols.WSTrust.RequestSecurityToken with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.SecondaryParameters" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Protocols::WSTrust::RequestSecurityToken ^ SecondaryParameters { System::IdentityModel::Protocols::WSTrust::RequestSecurityToken ^ get(); void set(System::IdentityModel::Protocols::WSTrust::RequestSecurityToken ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Protocols.WSTrust.RequestSecurityToken</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets parameters for which the requestor is not the originator.</summary>
<value>A <see cref="T:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken" /> that contains secondary parameters for the request; that is, parameters for which the requestor is not the originator.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of a wst:SecondaryParameters element. This optional element contains parameters for which the requestor is not the originator. An STS may choose to use the values found in this element based on its policy.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ValidateTarget">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.SecurityTokenElement ValidateTarget { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.SecurityTokenElement ValidateTarget" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.ValidateTarget" />
<MemberSignature Language="VB.NET" Value="Public Property ValidateTarget As SecurityTokenElement" />
<MemberSignature Language="F#" Value="member this.ValidateTarget : System.IdentityModel.Tokens.SecurityTokenElement with get, set" Usage="System.IdentityModel.Protocols.WSTrust.RequestSecurityToken.ValidateTarget" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::SecurityTokenElement ^ ValidateTarget { System::IdentityModel::Tokens::SecurityTokenElement ^ get(); void set(System::IdentityModel::Tokens::SecurityTokenElement ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityTokenElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the token to be validated in a WS-Trust validate request.</summary>
<value>A <see cref="T:System.IdentityModel.Tokens.SecurityTokenElement" /> that contains the token to be validated.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of a wst:ValidateTarget element. This element carries the information about the token to be validated in a WS-Trust validate request.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>