Skip to content
masks

Actors

Actors are records of the people and computers that access your system. Actors have a profile, credentials, and anything else necessary to secure their account.

Adding actors

There are a number of options for adding actors, depending on your use-case.

Signup & invitations

Open signups and invitations are disabled by default.

When signups are enabled, actors will be able to create new accounts with their nickname, email, passkey, or single sign-on provider. They can also invite others to signup as well, if enabled.

actors.yml

Like other data, you can seed actors with an actors.yml:

actors.yml
manager:
  manager: true
  nickname: tester
  password: <%= ENV['MASKS_MANAGER_PASSWORD'] %>


tester:
  nickname: tester
  password: password

Command line

Use the actor command to add and edit actors:

Terminal window
masks actor tester password=password

Ruby API

You can also seed actors in Ruby with the Masks global:

Masks.seed_actor("tester", password: "password").save

Defaults

You can supply a set of defaults for all newly created actors in your masks.yml:

masks.yml
actor_scopes:
  - one two three

Settings

key string The actor's unique key.
default auto-generated
name string A name for the actor.
default null
uuid string A public UUID for the actor.
default random UUIDv4
nickname string The actors' semi-public, unique nickname.
default null
scopes string A list of scopes granted to the actor.
default null
avatar_url string .
default null
tz string The actor's preferred timezone.
default server timezone
created_at datetime The time the actor was created.
read-only
updated_at datetime The last time the actor was saved.
read-only
onboarded_at datetime .
read-only
password_changed_at datetime .
read-only
password string The actor's secret password.
default null