Backplane.Oauth.AuthorizeResponse (backplane_oauth v1.10.77)

Copy Markdown View Source

Response returned in case of authorization request success. Provides utilities and mandatory data needed to respond to the authorize part of implicit, code and hybrid flows.

Summary

Types

t()

Functions

from_tokens(params, request)
redirect_to_url(response)

Types

t()

@type t() :: %Backplane.Oauth.AuthorizeResponse{
  access_token: String.t() | nil,
  code: String.t() | nil,
  code_challenge: String.t() | nil,
  code_challenge_method: String.t() | nil,
  expires_in: integer(),
  id_token: String.t() | nil,
  redirect_uri: String.t(),
  response_mode: String.t() | nil,
  state: String.t() | nil,
  token_type: String.t() | nil,
  type: :token | :code | :hybrid
}

Functions

from_tokens(params, request)

@spec from_tokens(
  %{
    required(type :: :code | :token | :id_token) =>
      token :: Backplane.Oauth.Token.t() | String.t()
  },
  request ::
    Backplane.Oauth.CodeRequest.t()
    | Backplane.Oauth.TokenRequest.t()
    | Backplane.Oauth.HybridRequest.t()
) :: t()

redirect_to_url(response)

@spec redirect_to_url(t()) :: url :: String.t()