cassette v1.0.0 Cassette.User
This is the struct that represents the user returned by a Validation request
Summary
Functions
Tests if the user has the given role
.
This function does not alter the role when checking against the list of authorities
Tests if the user has the given role
respecting the base_authority
set in the default configuration
Tests if the user has the given role
using the base_authority
set in the default configuration
Initializes a Cassette.User
struct, mapping the list of authorities to it’s internal representation
Types
Functions
Specs
has_raw_role?(any, any) :: boolean
has_raw_role?(Cassette.User.t, String.t) :: boolean
Tests if the user has the given role
.
This function does not alter the role when checking against the list of authorities.
If your user has the ACME_ADMIN
authority the following is true:
iex> Cassette.User.has_role?(some_user, "ACME_ADMIN")
true
This function returns false when user is not a Cassette.User.t
Specs
has_role?(any, any) :: boolean
has_role?(Cassette.User.t, String.t) :: boolean
Tests if the user has the given role
respecting the base_authority
set in the default configuration
If your base_authority
is ACME
and the user has the ACME_ADMIN
authority, then the following is true:
iex> Cassette.User.has_role?(some_user, "ADMIN")
true
This function returns false when user is not a Cassette.User.t
Specs
has_role?(any, any, any) :: boolean
has_role?(Cassette.User.t, Cassette.Config.t, String.t) :: boolean
Tests if the user has the given role
using the base_authority
set in the default configuration
If you are using custom a Cassette.Support
server you can use this function to respect it’s base_authority
This function returns false when user is not a Cassette.User.t
Specs
new(String.t, [String.t]) :: Cassette.User.t
Initializes a Cassette.User
struct, mapping the list of authorities to it’s internal representation