Cassette.User (cassette v1.5.3)

This is the struct that represents the user returned by a Validation request

Link to this section Summary

Types

t()

Functions

has_raw_role?(user, role)

See Cassette.User.raw_role?/2.

has_role?(user, role)

See Cassette.User.role?/2.

has_role?(user, config, role)

See Cassette.User.role?/3.

new(login, authorities)

Initializes a Cassette.User struct, mapping the list of authorities to it's internal representation

new(login, type, authorities)

Initializes a Cassette.User struct, with a type attribute and mapping the list of authorities to it's internal representation

new(login, type, authorities, attributes)

Initializes a Cassette.User struct, with a type attribute, mapping the list of authorities, and any extra attribute returned by the server

raw_role?(arg1, raw_role)

Tests if the user has the given role. This function does not alter the role when checking against the list of authorities.

role?(user, role)

Tests if the user has the given role respecting the base_authority set in the default configuration

role?(user, arg2, role)

Tests if the user has the given role using the base_authority set in the default configuration

Link to this section Types

t()

Specs

t() :: %Cassette.User{
  attributes: map(),
  authorities: term(),
  login: String.t(),
  type: term()
}

Link to this section Functions

has_raw_role?(user, role)

See Cassette.User.raw_role?/2.

has_role?(user, role)

See Cassette.User.role?/2.

has_role?(user, config, role)

See Cassette.User.role?/3.

new(login, authorities)

Specs

new(String.t(), [String.t()]) :: t()

Initializes a Cassette.User struct, mapping the list of authorities to it's internal representation

new(login, type, authorities)

Specs

new(String.t(), String.t(), [String.t()]) :: t()

Initializes a Cassette.User struct, with a type attribute and mapping the list of authorities to it's internal representation

new(login, type, authorities, attributes)

Specs

new(String.t(), String.t(), [String.t()], map()) :: t()

Initializes a Cassette.User struct, with a type attribute, mapping the list of authorities, and any extra attribute returned by the server

raw_role?(arg1, raw_role)

Specs

raw_role?(t() | any(), String.t() | any()) :: 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.raw_role?(some_user, "ACME_ADMIN")
true
iex> Cassette.User.has_raw_role?(some_user, "ACME_ADMIN")
true

This function returns false when user is not a Cassette.User.t

role?(user, role)

Specs

role?(t() | any(), String.t() | any()) :: 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.role?(some_user, "ADMIN")
true
iex> Cassette.User.has_role?(some_user, "ADMIN")
true

This function returns false when user is not a Cassette.User.t

role?(user, arg2, role)

Specs

role?(t() | any(), Cassette.Config.t() | any(), String.t() | any()) :: 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