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

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

@type raw() :: String.t()
@type 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
@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.

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

Determines if scope string contains openid scope.

@spec openid() :: t()

Returns 'openid' scope

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

Splits an OAuth scope string into individual scopes as string

examples

Examples

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