-
Notifications
You must be signed in to change notification settings - Fork 32
/
KerberosSupplementalTicket.xml
313 lines (313 loc) · 16.2 KB
/
KerberosSupplementalTicket.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
<Type Name="KerberosSupplementalTicket" FullName="Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket">
<TypeSignature Language="C#" Value="public class KerberosSupplementalTicket" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit KerberosSupplementalTicket extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket" />
<TypeSignature Language="VB.NET" Value="Public Class KerberosSupplementalTicket" />
<TypeSignature Language="F#" Value="type KerberosSupplementalTicket = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.48.1.0</AssemblyVersion>
<AssemblyVersion>4.49.1.0</AssemblyVersion>
<AssemblyVersion>4.51.0.0</AssemblyVersion>
<AssemblyVersion>4.52.0.0</AssemblyVersion>
<AssemblyVersion>4.53.0.0</AssemblyVersion>
<AssemblyVersion>4.54.0.0</AssemblyVersion>
<AssemblyVersion>4.54.1.0</AssemblyVersion>
<AssemblyVersion>4.55.0.0</AssemblyVersion>
<AssemblyVersion>4.56.0.0</AssemblyVersion>
<AssemblyVersion>4.57.0.0</AssemblyVersion>
<AssemblyVersion>4.58.0.0</AssemblyVersion>
<AssemblyVersion>4.58.1.0</AssemblyVersion>
<AssemblyVersion>4.59.0.0</AssemblyVersion>
<AssemblyVersion>4.60.0.0</AssemblyVersion>
<AssemblyVersion>4.60.1.0</AssemblyVersion>
<AssemblyVersion>4.60.2.0</AssemblyVersion>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
<AssemblyVersion>4.61.0.0</AssemblyVersion>
<AssemblyVersion>4.61.1.0</AssemblyVersion>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
<AssemblyVersion>4.62.0.0</AssemblyVersion>
<AssemblyVersion>4.63.0.0</AssemblyVersion>
<AssemblyVersion>4.64.0.0</AssemblyVersion>
<AssemblyVersion>4.64.1.0</AssemblyVersion>
<AssemblyVersion>4.65.0.0</AssemblyVersion>
<AssemblyVersion>4.66.0.0</AssemblyVersion>
<AssemblyVersion>4.66.1.0</AssemblyVersion>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Class for Kerberos tickets that are included as claims and used as a supplemental token in an OAuth/OIDC
protocol response.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public KerberosSupplementalTicket ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Creates a new instance of <see cref="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public KerberosSupplementalTicket (string errorMessage);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string errorMessage) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (errorMessage As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket : string -> Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket" Usage="new Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket errorMessage" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="errorMessage" Type="System.String" />
</Parameters>
<Docs>
<param name="errorMessage">Error message to be set.</param>
<summary>
Creates a new instance of <see cref="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket" /> class with error message.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientKey">
<MemberSignature Language="C#" Value="public string ClientKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ClientKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ClientKey" />
<MemberSignature Language="VB.NET" Value="Public Property ClientKey As String" />
<MemberSignature Language="F#" Value="member this.ClientKey : string with get, set" Usage="Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ClientKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonPropertyName("clientKey")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonPropertyName("clientKey")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get or Sets the client key used to encrypt the client portion of the ticket.
This is optional. This will be null if KeyType is null.
This MUST be protected in the protocol response.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientName">
<MemberSignature Language="C#" Value="public string ClientName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ClientName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ClientName" />
<MemberSignature Language="VB.NET" Value="Public Property ClientName As String" />
<MemberSignature Language="F#" Value="member this.ClientName : string with get, set" Usage="Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ClientName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonPropertyName("cn")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonPropertyName("cn")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get or Sets the client name. Depending on the ticket, this can be either a UserPrincipalName or SamAccountName.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ErrorMessage">
<MemberSignature Language="C#" Value="public string ErrorMessage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ErrorMessage" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ErrorMessage" />
<MemberSignature Language="VB.NET" Value="Public Property ErrorMessage As String" />
<MemberSignature Language="F#" Value="member this.ErrorMessage : string with get, set" Usage="Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ErrorMessage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonPropertyName("error")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonPropertyName("error")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get or Sets the error message that server encountered when creating a ticket granting ticket.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="KerberosMessageBuffer">
<MemberSignature Language="C#" Value="public string KerberosMessageBuffer { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string KerberosMessageBuffer" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.KerberosMessageBuffer" />
<MemberSignature Language="VB.NET" Value="Public Property KerberosMessageBuffer As String" />
<MemberSignature Language="F#" Value="member this.KerberosMessageBuffer : string with get, set" Usage="Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.KerberosMessageBuffer" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonPropertyName("messageBuffer")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonPropertyName("messageBuffer")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get or Sets the Base64 encoded KERB_MESSAGE_BUFFER
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="KeyType">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.Kerberos.KerberosKeyTypes KeyType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Identity.Client.Kerberos.KerberosKeyTypes KeyType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.KeyType" />
<MemberSignature Language="VB.NET" Value="Public Property KeyType As KerberosKeyTypes" />
<MemberSignature Language="F#" Value="member this.KeyType : Microsoft.Identity.Client.Kerberos.KerberosKeyTypes with get, set" Usage="Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.KeyType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonPropertyName("keyType")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonPropertyName("keyType")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.Kerberos.KerberosKeyTypes</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get or Sets the client key type.This is optional.This will be null if ClientKey is null.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Realm">
<MemberSignature Language="C#" Value="public string Realm { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Realm" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.Realm" />
<MemberSignature Language="VB.NET" Value="Public Property Realm As String" />
<MemberSignature Language="F#" Value="member this.Realm : string with get, set" Usage="Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.Realm" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonPropertyName("realm")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonPropertyName("realm")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get or Sets the Kerberos realm/domain name.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ServicePrincipalName">
<MemberSignature Language="C#" Value="public string ServicePrincipalName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ServicePrincipalName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ServicePrincipalName" />
<MemberSignature Language="VB.NET" Value="Public Property ServicePrincipalName As String" />
<MemberSignature Language="F#" Value="member this.ServicePrincipalName : string with get, set" Usage="Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ServicePrincipalName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonPropertyName("sn")]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonPropertyName("sn")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get or Sets the target service principal name (SPN).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="kerberosSupplementalTicket.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a string representation of the data captured in the Kerberos supplemental ticket.
</summary>
<returns>A string containing the realm, service principal name, client name, and key type.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
</Type>