-
Notifications
You must be signed in to change notification settings - Fork 260
/
SecurityToken.xml
148 lines (148 loc) · 9 KB
/
SecurityToken.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
<Type Name="SecurityToken" FullName="Microsoft.Azure.Relay.SecurityToken">
<TypeSignature Language="C#" Value="public class SecurityToken" FrameworkAlternate="azure-dotnet" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SecurityToken extends System.Object" FrameworkAlternate="azure-dotnet" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Relay.SecurityToken" />
<TypeSignature Language="VB.NET" Value="Public Class SecurityToken" FrameworkAlternate="azure-dotnet" />
<TypeSignature Language="F#" Value="type SecurityToken = class" />
<TypeSignature Language="C#" Value="public abstract class SecurityToken" FrameworkAlternate="azure-dotnet-preview" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit SecurityToken extends System.Object" FrameworkAlternate="azure-dotnet-preview" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class SecurityToken" FrameworkAlternate="azure-dotnet-preview" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provides information about a security token such as audience, expiry time, and the string token value.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected SecurityToken ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.SecurityToken.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected SecurityToken (string tokenString, string audienceFieldName, string expiresOnFieldName, string keyValueSeparator, string pairSeparator);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(string tokenString, string audienceFieldName, string expiresOnFieldName, string keyValueSeparator, string pairSeparator) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.SecurityToken.#ctor(System.String,System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (tokenString As String, audienceFieldName As String, expiresOnFieldName As String, keyValueSeparator As String, pairSeparator As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Relay.SecurityToken : string * string * string * string * string -> Microsoft.Azure.Relay.SecurityToken" Usage="new Microsoft.Azure.Relay.SecurityToken (tokenString, audienceFieldName, expiresOnFieldName, keyValueSeparator, pairSeparator)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="tokenString" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="audienceFieldName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="expiresOnFieldName" Type="System.String" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="keyValueSeparator" Type="System.String" Index="3" FrameworkAlternate="azure-dotnet" />
<Parameter Name="pairSeparator" Type="System.String" Index="4" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="tokenString">A token in string format.</param>
<param name="audienceFieldName">The key name for the audience field.</param>
<param name="expiresOnFieldName">The key name for the expires on field.</param>
<param name="keyValueSeparator">The separator between keys and values.</param>
<param name="pairSeparator">The separator between different key/value pairs.</param>
<summary>
Creates a new instance of the <see cref="T:Microsoft.Azure.Relay.SecurityToken" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Audience">
<MemberSignature Language="C#" Value="public string Audience { get; }" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".property instance string Audience" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Relay.SecurityToken.Audience" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Audience As String" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="member this.Audience : string" Usage="Microsoft.Azure.Relay.SecurityToken.Audience" />
<MemberSignature Language="C#" Value="public abstract string Audience { get; }" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Audience As String" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the audience of this token.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExpiresAtUtc">
<MemberSignature Language="C#" Value="public DateTime ExpiresAtUtc { get; }" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime ExpiresAtUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Relay.SecurityToken.ExpiresAtUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExpiresAtUtc As DateTime" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="member this.ExpiresAtUtc : DateTime" Usage="Microsoft.Azure.Relay.SecurityToken.ExpiresAtUtc" />
<MemberSignature Language="C#" Value="public abstract DateTime ExpiresAtUtc { get; }" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property ExpiresAtUtc As DateTime" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the expiration time of this token.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TokenString">
<MemberSignature Language="C#" Value="public string TokenString { get; }" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".property instance string TokenString" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Relay.SecurityToken.TokenString" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TokenString As String" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="member this.TokenString : string" Usage="Microsoft.Azure.Relay.SecurityToken.TokenString" />
<MemberSignature Language="C#" Value="public abstract string TokenString { get; }" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property TokenString As String" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the actual token as a string.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>