817ccf3620
* Add Quickstart Guide * Update installation * Remove unused files * Update support/backing * Tweaks in concepts * Setup file structure for API reference 2.0 * Setup page layout for reference * Add clean-urls plugin * getting started updates * Finish authentication rest * getting started updates * Render stylus in 2 spaces * Various * Various * Finish activity docs * Add collections reference * Add extension reference * concepts updates * Fields/tweaks * Add files doc * Add revisions * concepts docs * More api reference * Finish rest api reference (finally) * initial concepts * More things * Add assets api ref * Move sections from file to assets * Add environment variables * contributing docs * Add field transforms page * Left align table headers * concept links * Add API config * Fix mobile nav * Add migrating a project * doc link fixes Co-authored-by: Ben Haynes <ben@rngr.org>
2.8 KiB
Users
Directus Users are the individual accounts that let you authenticate into the API and App. Each user belongs to a Role which defines its granular Permissions.
To use the App or API, you'll need a valid Directus User. Each user is assigned to a Role that determines what they have access to see and do. This means that the experience of users may vary significantly depending on their role's access. For example, while some users may see all platform content, others may only see a smaller subset of Modules, Collections, or Fields.
Relevant Guides
- Setting up your User Profile
- Creating a User
- Inviting a User
- Configuring a User
- Archiving a User
- Deleting a User
User Fields
Directus ships with a basic set of user fields that are displayed on the User Detail pages. While these system fields are required/locked, you can extend the Directus Users Collection with any number of custom fields to create a fully tailored User Directory. To add fields within system collections, simply follow the normal guide for Creating a Field.
Below are the system User fields included by default.
- First Name — The user's given name
- Last Name — The user's family name
- Email — The user's email address used for login/authenticating and email updates
- Password — The private string used for login/authenticating (stored as a secure hash)
- Avatar — An image displayed throughout the App that represents the user
- Location — Can be used for the user's city, country, office name, etc
- Title — The name of the position the user holds at their company or organization
- Description — A description or bio of the user
- Tags — A set of keywords useful when searching within the User Directory
- Language — (User Preference) The language to use for this user's App language
- Theme — (User Preference) Light, Dark, or Auto (based on the user's OS preferences)
- Two-Factor Auth — (User Preference) Enables authenticating with 2FA
- Status — (Admin Only) Determines if the user is active within the App/API
- Role — (Admin Only) The user's role determines their permissions and access
- Token — (Admin Only) A static string used for authenticating within the API
The sidebar's info component also includes the following readonly details:
- User Key — The primary key of the user
- Last Page — The last App page accessed by the user
- Last Access — The timestamp of the user's last App or API action