f862f0f8f3
* 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 * link fixes Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
3.0 KiB
Users
Users are the individual accounts for authenticating into the API and App. Each user belongs to a Role which defines its Permissions. Learn more about Users.
Creating a User
- Navigate to the User Library
- Click the Create User action button in the header
- Enter an Email Address
- Optional: Complete the other user form fields
Inviting a User
- Navigate to Settings > Roles & Permissions > [Role Name]
- Scroll to the Users in Role field
- Click the Invite Users button
- Enter one or more email addresses, separated by commas, in the modal
- Click Invite
At this point the invited user(s) will receive an email with a link to the App where they set a password and enable their account.
Configuring a User
- Navigate to the User Library
- Click on the user you wish to manage
- Complete the form of User Fields
::: warning User Preferences
This section of the User Detail is only visible/editable by the current user, and admins.
:::
Status
The User's Status determines if an account is able to access the platform or not. Only the active state is able to authenticate, all others are simply descriptive inactive states.
- Draft — An incomplete user; no App/API access
- Invited — Has a pending invite to the project; no App/API access until accepted
- Active — The only status that has proper access to the App and API
- Suspended — A user that has been temporarily disabled; no App/API access
- Archived — A soft-deleted user; no App/API access
::: warning Admin Only
Only admins can adjust this field's value.
:::
Role
Setting the user's role determines their access, permissions, and App presentation. You can adjust a user's role from the User Detail page, or from the Users in Role field within Settings > Roles & Permissions > [Role Name].
::: warning Admin Only
Only admins can adjust this field's value.
:::
Token
A user's token is an alternate way to authenticate into the API using a static string. When NULL, the token is disabled. When enabled, ensure that a secure string is used.
Archiving a User
- Navigate to the User Library
- Click the user you with to archive to go to their User Detail page
- Click the orange Archive User action button in the header
- Confirm this decision by clicking Archive in the dialog
::: warning Disables Access
Archiving uses soft-delete, therefore archived users are unable to access the App or API.
:::
Deleting a User
- Navigate to the User Library
- Select one or more users you wish to delete
- Click the red Delete User action button in the header
- Confirm this decision by clicking Delete in the dialog
::: danger Irreversible Change
Unlike the soft-delete of archiving, this process is a hard-delete. Therefore, this action is permanent and can not be undone. Please proceed with caution.
:::