Class RefreshToken

Namespace

Duende.IdentityServer.Models

Assembly

Duende.IdentityServer.Storage.dll

Models a refresh token.

public class RefreshToken

Inheritance

object

RefreshToken

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RefreshToken()

public RefreshToken()

Properties

AccessToken

Obsolete. This property remains to keep backwards compatibility with serialized persisted grants.

[Obsolete("Use AccessTokens or Set/GetAccessToken instead.")]
public Token? AccessToken { get; set; }

Property Value

Token

The access token.

AccessTokens

Gets or sets the resource indicator specific access token.

public Dictionary<string, Token> AccessTokens { get; set; }

Property Value

Dictionary<string, Token>

The access token.

AuthorizedResourceIndicators

The resource indicators. Null indicates there was no authorization step, thus no restrictions. Non-null means there was an authorization step, and subsequent requested resource indicators must be in the original list.

public IEnumerable<string>? AuthorizedResourceIndicators { get; set; }

Property Value

IEnumerable<string>

AuthorizedScopes

Gets the scopes.

public IEnumerable<string> AuthorizedScopes { get; set; }

Property Value

IEnumerable<string>

The scopes.

ClientId

Gets the client identifier.

public string ClientId { get; set; }

Property Value

string

The client identifier.

ConsumedTime

Gets or sets the consumed time.

public DateTime? ConsumedTime { get; set; }

Property Value

DateTime?

The consumed time.

CreationTime

Gets or sets the creation time.

public DateTime CreationTime { get; set; }

Property Value

DateTime

The creation time.

Description

Gets the description the user assigned to the device being authorized.

public string? Description { get; set; }

Property Value

string

The description.

Lifetime

Gets or sets the life time.

public int Lifetime { get; set; }

Property Value

int

The life time.

ProofType

The type of proof used for the refresh token. Null indicates refresh tokens created prior to this property being added.

public ProofType? ProofType { get; set; }

Property Value

ProofType?

SessionId

Gets the session identifier.

public string? SessionId { get; set; }

Property Value

string

The session identifier.

Subject

Gets or sets the original subject that requested the token.

public ClaimsPrincipal Subject { get; set; }

Property Value

ClaimsPrincipal

The subject.

SubjectId

Gets the subject identifier.

public string? SubjectId { get; }

Property Value

string

The subject identifier.

Version

Gets or sets the version number.

public int Version { get; set; }

Property Value

int

The version.

Methods

GetAccessToken(string?)

Returns the access token based on the resource indicator.

public Token? GetAccessToken(string? resourceIndicator = null)

Parameters

resourceIndicator string

Returns

Token

SetAccessToken(Token, string?)

Sets the access token based on the resource indicator.

public void SetAccessToken(Token token, string? resourceIndicator = null)

Parameters

token Token

resourceIndicator string