Packages

oidcc

3.2.6
3.7.2 3.7.1 3.7.0 3.6.0 3.5.2 3.5.1 3.5.0 retired 3.4.0 3.3.0 3.2.6 3.2.5 3.2.4 3.2.3 3.2.2 3.2.1 3.2.0 3.2.0-beta.3 3.2.0-beta.2 retired 3.2.0-beta.1 retired 3.1.2 3.1.2-beta.1 retired 3.1.1 retired 3.1.0 retired 3.1.0-beta.2 retired 3.1.0-beta.1 retired 3.0.2 3.0.1 retired 3.0.0 retired 3.0.0-rc.6 retired 3.0.0-rc.5 retired 3.0.0-rc.4 retired 3.0.0-rc.3 retired 3.0.0-rc.2 retired 3.0.0-rc.1 retired 3.0.0-alpha.5 retired 3.0.0-alpha.4 retired 3.0.0-alpha.3 retired 3.0.0-alpha.2 retired 3.0.0-alpha.1 retired 2.0.0-alpha.2 retired 2.0.0-alpha.1 retired 1.8.1 retired 1.8.0 retired 1.7.0 retired 1.6.0 retired 1.5.1 retired 1.5.0 retired 1.4.0 retired 1.3.0 retired 1.2.1 retired 1.2.0 retired 1.1.0 retired 1.0.1 retired 1.0.0 retired

OpenID Connect client library for the BEAM.

HexDocs

Current section

Files

Jump to
Readme
54 Versions
3 Dependencies
Dependants
1 Advisory
Files
Activity
oidcc lib oidcc token access.ex
Raw

lib/oidcc/token/access.ex 

defmodule Oidcc.Token.Access do

  @moduledoc """

  Access Token struct.



  See `t::oidcc_token.access/0`

  """

  @moduledoc since: "3.0.0"



  alias Oidcc.ClientContext



  use Oidcc.RecordStruct,

    internal_name: :token,

    record_name: :oidcc_token_access,

    record_type_module: :oidcc_token,

    record_type_name: :access,

    hrl: "include/oidcc_token.hrl"



  @typedoc since: "3.0.0"

  @type t() :: %__MODULE__{

          token: String.t(),

          expires: pos_integer() | :undefined,

          type: String.t()

        }



  @doc """

  Generate a map of authorization headers to use when using the given

  `Oidcc.Token.Access` struct to access an API endpoint.

  """

  @doc since: "3.2.0"

  @spec authorization_headers(

          access_token :: t(),

          method :: :get | :post,

          endpoint :: String.t(),

          client_context :: ClientContext.t()

        ) :: %{String.t() => String.t()}

  @spec authorization_headers(

          access_token :: t(),

          method :: :get | :post,

          endpoint :: String.t(),

          client_context :: ClientContext.t(),

          opts :: :oidcc_token.authorization_headers_opts()

        ) :: %{String.t() => String.t()}

  def authorization_headers(

        access_token,

        method,

        endpoint,

        client_context,

        opts \\ %{}

      ),

      do:

        :oidcc_token.authorization_headers(

          struct_to_record(access_token),

          method,

          endpoint,

          ClientContext.struct_to_record(client_context),

          opts

        )

end