SimpleWebSecurityToken SimpleWebSecurityToken Class

A security token that wraps a Simple Web Token.

Syntax

Declaration

public class SimpleWebSecurityToken : SecurityTokenPublic Class SimpleWebSecurityToken
    Inherits SecurityToken

Inheritance Hierarchy

Constructors summary

Initializes a new instance of the SimpleWebSecurityToken class with the specified Simple Web Token.

Initializes a new instance of the SimpleWebSecurityToken class with the specified Simple Web Token and expiry date.

Initializes a new instance of the SimpleWebSecurityToken class.

Initializes a new instance of the SimpleWebSecurityToken class with the specified token ID and Simple Web Token.

Properties summary

Gets the audience for the simple web token.

Gets the audience field name.

Gets the date and time the security token will expire.

Gets the field name associated with the token expiration.

Gets the ID associated with the Simple Web Token.

Gets the key value separator associated with the token.

Gets the pair separator associated with the token.

Gets the cryptographic keys associated with the security token.

Gets the Simple Web Token.

Not implemented.

Not implemented.

Constructors

  • SimpleWebSecurityToken(String)
    SimpleWebSecurityToken(String)

    Initializes a new instance of the SimpleWebSecurityToken class with the specified Simple Web Token.

    public SimpleWebSecurityToken(string tokenString)Public Sub New(tokenString As String)

    Parameters

    • tokenString

      A string that represents the Simple Web Token.

  • SimpleWebSecurityToken(String, DateTime)
    SimpleWebSecurityToken(String, DateTime)

    Initializes a new instance of the SimpleWebSecurityToken class with the specified Simple Web Token and expiry date.

    public SimpleWebSecurityToken(string tokenString, DateTime expiry)Public Sub New(tokenString As String, expiry As Date)

    Parameters

    • tokenString

      A string that represents the Simple Web Token.

    • expiry

      The expiry date of the simple web token.

  • SimpleWebSecurityToken(String, DateTime, String)
    SimpleWebSecurityToken(String, DateTime, String)

    Initializes a new instance of the SimpleWebSecurityToken class.

    public SimpleWebSecurityToken(string tokenString, DateTime expiry, string audience)Public Sub New(tokenString As String, expiry As Date, audience As String)

    Parameters

    • tokenString

      A string that represents the Simple Web Token.

    • expiry

      The expiry date of the simple web token.

    • audience

      The audience for the simple web token.

  • SimpleWebSecurityToken(String, String)
    SimpleWebSecurityToken(String, String)

    Initializes a new instance of the SimpleWebSecurityToken class with the specified token ID and Simple Web Token.

    public SimpleWebSecurityToken(string id, string tokenString)Public Sub New(id As String, tokenString As String)

    Parameters

    • id

      A unique identifier for the Simple Web Token.

    • tokenString

      A string that represents the Simple Web Token.

    Exceptions

Properties

  • Audience
    Audience

    Gets the audience for the simple web token.

    public string Audience { get; }Public ReadOnly Property Audience As String

    Property Value

  • AudienceFieldName
    AudienceFieldName

    Gets the audience field name.

    protected virtual string AudienceFieldName { get; }Protected Overridable ReadOnly Property AudienceFieldName As String

    Property Value

  • ExpiresOn
    ExpiresOn

    Gets the date and time the security token will expire.

    public DateTime ExpiresOn { get; }Public ReadOnly Property ExpiresOn As Date

    Property Value

  • ExpiresOnFieldName
    ExpiresOnFieldName

    Gets the field name associated with the token expiration.

    protected virtual string ExpiresOnFieldName { get; }Protected Overridable ReadOnly Property ExpiresOnFieldName As String

    Property Value

    • The field name associated with the token expiration.

  • Id
    Id

    Gets the ID associated with the Simple Web Token.

    public override string Id { get; }Public Overrides ReadOnly Property Id As String

    Property Value

    • The ID associated with the Simple Web Token.

    Overrides

  • KeyValueSeparator
    KeyValueSeparator

    Gets the key value separator associated with the token.

    protected virtual string KeyValueSeparator { get; }Protected Overridable ReadOnly Property KeyValueSeparator As String

    Property Value

    • The key value separator associated with the token.

  • PairSeparator
    PairSeparator

    Gets the pair separator associated with the token.

    protected virtual string PairSeparator { get; }Protected Overridable ReadOnly Property PairSeparator As String

    Property Value

    • The pair separator associated with the token.

  • SecurityKeys
    SecurityKeys

    Gets the cryptographic keys associated with the security token.

    public override ReadOnlyCollection<SecurityKey> SecurityKeys { get; }Public Overrides ReadOnly Property SecurityKeys As ReadOnlyCollection(Of SecurityKey)

    Property Value

    Overrides

  • Token
    Token

    Gets the Simple Web Token.

    public string Token { get; }Public ReadOnly Property Token As String

    Property Value

  • ValidFrom
    ValidFrom

    Not implemented.

    public override DateTime ValidFrom { get; }Public Overrides ReadOnly Property ValidFrom As Date

    Property Value

    Overrides

  • ValidTo
    ValidTo

    Not implemented.

    public override DateTime ValidTo { get; }Public Overrides ReadOnly Property ValidTo As Date

    Property Value

    Overrides

Details

Namespace

Microsoft.ServiceBus

Assembly

Microsoft.ServiceBus.dll