View Source Boruta.Oauth.Scope (Boruta core v2.0.0)

OAuth scope schema and utilities

Link to this section Summary

Functions

Determines if artifact is authorized to access given scope.

Determines if scope string contains openid scope.

Returns 'openid' scope

Splits an OAuth scope string into individual scopes as string

Link to this section Types

Specs

raw() :: String.t()

Specs

t() :: %Boruta.Oauth.Scope{
  id: any() | nil,
  label: String.t() | nil,
  name: String.t(),
  public: boolean() | nil
}

Link to this section Functions

Link to this function

authorized_scopes(against, scopes, public_scopes \\ [])

View Source

Specs

authorized_scopes(
  against :: List | Boruta.Oauth.Token.t() | Boruta.Oauth.Client.t(),
  scopes :: [String.t()],
  public_scopes :: [String.t()]
) :: authorized_scopes :: [String.t()]

Determines if artifact is authorized to access given scope.

Specs

contains_openid?(oauth_scope :: String.t()) :: boolean()

Determines if scope string contains openid scope.

Specs

openid() :: t()

Returns 'openid' scope

Specs

split(oauth_scope :: String.t() | nil) :: [raw()]

Splits an OAuth scope string into individual scopes as string

Examples

iex> scope("a:scope another:scope")
["a:scope", "another:scope"]