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

OAuth scope schema and utilities

Summary

Types

raw()
t()

Functions

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

Determines if artifact is authorized to access given scope.

contains_openid?(scope)

Determines if scope string contains openid scope.

openid()

Returns 'openid' scope

split(scope)

Splits an OAuth scope string into individual scopes as string

Types

Link to this type

raw()

View Source 
@type raw() :: String.t()
Link to this type

t()

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

Functions

Link to this function

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

View Source 
@spec 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.

Link to this function

contains_openid?(scope)

View Source 
@spec contains_openid?(oauth_scope :: String.t()) :: boolean()

Determines if scope string contains openid scope.

Link to this function

openid()

View Source 
@spec openid() :: t()

Returns 'openid' scope

Link to this function

split(scope)

View Source 
@spec 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"]