Latch.Config (latch v0.4.0)

Copy Markdown

The configuration that drives the client.

Fields

  • :store - a module implementing Latch.Store
  • :name - the name of the Latch instance
  • :mode - :confidential, :public, or :localhost
  • :redirect_uri - the OAuth callback URL
  • :scope - the requsted scopes
  • :client_id - the URL of the published client metadata document
  • :signing_key - the JSON-encoded ES256 private JWK for private_key_jwt as string
  • :client_name - shown on the authorization consent screen
  • :client_uri - client home page

Summary

Types

mode()

@type mode() :: :confidential | :public | :localhost

t()

@type t() :: %Latch.Config{
  client_id: String.t() | nil,
  client_name: String.t() | nil,
  client_uri: String.t() | nil,
  mode: mode(),
  name: atom() | pid(),
  redirect_uri: String.t(),
  request_ttl: non_neg_integer(),
  scope: String.t(),
  signing_key: map() | nil,
  store: module()
}

Functions

confidential?(config)

localhost?(config)