WardrikOAuth.Metadata (wardrik_oauth v0.1.0-rc.1)

Copy Markdown

An authorization server's metadata, discovered from its issuer or resource.

Summary

Types

t()

An authorization server's metadata.

Functions

discover(provider, req_options)

Returns the metadata of provider's authorization server.

Types

t()

@type t() :: %WardrikOAuth.Metadata{
  authorization_endpoint: String.t() | nil,
  device_authorization_endpoint: String.t() | nil,
  documents_supported?: boolean(),
  iss_supported?: boolean(),
  issuer: String.t() | nil,
  registration_endpoint: String.t() | nil,
  token_endpoint: String.t()
}

An authorization server's metadata.

Functions

discover(provider, req_options)

@spec discover(WardrikOAuth.Provider.t(), keyword()) :: {:ok, t()} | {:error, term()}

Returns the metadata of provider's authorization server.

Uses the provider's own endpoints if it names both. Otherwise discovers them from issuer, or from resource's protected resource metadata.