Class RefreshServiceOptions
Inherited Members
Namespace: FastEndpoints.Security
Assembly: FastEndpoints.Security.dll
Syntax
public class RefreshServiceOptionsProperties
AccessTokenValidity
specifies how long the access token should be valid for. default is 5 minutes.
Declaration
public TimeSpan AccessTokenValidity { set; }Property Value
| Type | Description |
|---|---|
| TimeSpan |
Audience
specifies the token audience
Declaration
public string? Audience { set; }Property Value
| Type | Description |
|---|---|
| string |
Issuer
specifies the token issuer
Declaration
public string? Issuer { set; }Property Value
| Type | Description |
|---|---|
| string |
RefreshTokenValidity
specifies how long the refresh token should be valid for. default is 4 hours.
Declaration
public TimeSpan RefreshTokenValidity { set; }Property Value
| Type | Description |
|---|---|
| TimeSpan |
SigningKeyIsPemEncoded
specifies whether the key is pem encoded.
Declaration
public bool SigningKeyIsPemEncoded { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
TokenCompressionAlgorithm
the compression algorithm compressing the token payload.
Declaration
public string? TokenCompressionAlgorithm { get; set; }Property Value
| Type | Description |
|---|---|
| string |
TokenSigningAlgorithm
security algo used to sign tokens. defaults to HmacSha256 for symmetric keys.
Declaration
public string TokenSigningAlgorithm { set; }Property Value
| Type | Description |
|---|---|
| string |
TokenSigningKey
specifies the secret key used to sign the jwt. an exception will be thrown if a value is not specified when global JwtCreationOptions is not configured. i.e. if global JwtCreationOptions is configured, you don't need to set the following properties because the values will come from the globally configured settings:
TokenSigningKey / TokenSigningStyle / TokenSigningAlgorithm / Issuer / Audience
Declaration
public string? TokenSigningKey { set; }Property Value
| Type | Description |
|---|---|
| string |
TokenSigningStyle
specifies the signing style of the jwt. default is symmetric.
Declaration
public TokenSigningStyle TokenSigningStyle { set; }Property Value
| Type | Description |
|---|---|
| TokenSigningStyle |
Methods
Endpoint(string, Action<EndpointDefinition>)
endpoint configuration action
Declaration
public void Endpoint(string refreshEndpointRoute, Action<EndpointDefinition> ep)Parameters
| Type | Name | Description |
|---|---|---|
| string | refreshEndpointRoute | the route of the refresh token endpoint |
| Action<EndpointDefinition> | ep | the action to be performed on the endpoint definition |