Header menu logo FSharp.ATProto

OAuthServer Module

Server builder for composing the OAuth authorization server.

Types

Type Description

OAuthServerBuilder

Builder record for configuring the OAuth server.

Functions and values

Function or value Description

configure builder

Full Usage: configure builder

Parameters:
Returns: WebApplication

Build and configure a WebApplication with all OAuth routes mapped.

builder : OAuthServerBuilder
Returns: WebApplication

defaults

Full Usage: defaults

Returns: OAuthServerBuilder

Default builder with sensible defaults. Issuer must be set before building.

Returns: OAuthServerBuilder

withAccessTokenLifetime lifetime builder

Full Usage: withAccessTokenLifetime lifetime builder

Parameters:
Returns: OAuthServerBuilder

Set the access token lifetime.

lifetime : TimeSpan
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

withAccountStore store builder

Full Usage: withAccountStore store builder

Parameters:
Returns: OAuthServerBuilder

Set a custom account store.

store : IAccountStore
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

withConsentPath path builder

Full Usage: withConsentPath path builder

Parameters:
Returns: OAuthServerBuilder

Set the consent UI path (default: "/consent").

path : string
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

withIssuer issuer builder

Full Usage: withIssuer issuer builder

Parameters:
Returns: OAuthServerBuilder

Set the issuer URL for the OAuth server.

issuer : string
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

withPort port builder

Full Usage: withPort port builder

Parameters:
Returns: OAuthServerBuilder

Set the port the server listens on.

port : int
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

withRefreshTokenLifetime lifetime builder

Full Usage: withRefreshTokenLifetime lifetime builder

Parameters:
Returns: OAuthServerBuilder

Set the refresh token lifetime.

lifetime : TimeSpan
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

withReplayStore store builder

Full Usage: withReplayStore store builder

Parameters:
Returns: OAuthServerBuilder

Set a custom replay detection store.

store : IReplayStore
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

withRequestStore store builder

Full Usage: withRequestStore store builder

Parameters:
Returns: OAuthServerBuilder

Set a custom request store.

store : IRequestStore
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

withScopesSupported scopes builder

Full Usage: withScopesSupported scopes builder

Parameters:
Returns: OAuthServerBuilder

Set the supported scopes.

scopes : string list
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

withServiceDid did builder

Full Usage: withServiceDid did builder

Parameters:
Returns: OAuthServerBuilder

Set the service DID for the server.

did : Did
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

withSigningKey key builder

Full Usage: withSigningKey key builder

Parameters:
Returns: OAuthServerBuilder

Set the signing key for token creation.

key : ECDsa
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

withTokenStore store builder

Full Usage: withTokenStore store builder

Parameters:
Returns: OAuthServerBuilder

Set a custom token store.

store : ITokenStore
builder : OAuthServerBuilder
Returns: OAuthServerBuilder

Type something to start searching.