@directus/app 9.12.2 → 9.13.0

package/dist/assets/upgrades-migrations.15498a47.js

@@ -1 +0,0 @@
-import{a as n,o as c,b as d,w as o,g as e,e as s,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const u={class:"markdown-body"},h=t("A Project is a complete instance of Directus, including its "),p=e("strong",null,"Database",-1),g=t(", config file, asset storage, and any custom extensions. "),_=t("Learn more about Projects"),m=t("."),f=e("h2",{id:"upgrading-%2F-updating-a-project"},[t("Upgrading / Updating a Project "),e("a",{class:"header-anchor",href:"#upgrading-%2F-updating-a-project"},"#")],-1),y=e("ol",null,[e("li",null,"Backup your project"),e("li",null,[t("Run "),e("code",{class:""},"npm update")]),e("li",null,[t("Run "),e("code",{class:""},"npx directus database migrate:latest"),t(" to update the DB")])],-1),b=e("h2",{id:"backing-up-a-project"},[t("Backing-up a Project "),e("a",{class:"header-anchor",href:"#backing-up-a-project"},"#")],-1),v=e("ol",null,[e("li",null,[t("Make a copy of the "),e("strong",null,"files within each storage adapter"),t(", and store them in a safe place")]),e("li",null,[t("Make a copy of the "),e("strong",null,"Env file"),t(" ("),e("code",{class:""},"/api/.env"),t("), and store it in a safe place")]),e("li",null,"Create a database dump")],-1),w=e("h2",{id:"migrating-a-project"},[t("Migrating a Project "),e("a",{class:"header-anchor",href:"#migrating-a-project"},"#")],-1),k=e("p",null,"Directus doesn\u2019t rely on anything besides the database for it\u2019s operation. Therefore, migrating your Directus project can be done by moving the whole database to a new location using a database dump.",-1),j=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"File Storage"),e("p",null,"If you have files uploaded, make sure to copy those over as well, or use the same storage location in the new location of Directus.")],-1),D=e("h2",{id:"downgrading-a-project"},[t("Downgrading a Project "),e("a",{class:"header-anchor",href:"#downgrading-a-project"},"#")],-1),x=e("p",null,[t("Directus can be reverted to an earlier version by going to your terminal, navigating into your project folder and running "),e("code",{class:""},"npm install directus@<version>"),t(".")],-1),B=e("p",null,[t("If you ran any database migrations for a newer version, you can revert those by running "),e("code",{class:""},"npx directus database migrate:down")],-1),P=e("h2",{id:"deleting-a-project"},[t("Deleting a Project "),e("a",{class:"header-anchor",href:"#deleting-a-project"},"#")],-1),I=e("ol",null,[e("li",null,[t("Optional: "),e("strong",null,"Backup any local files"),t(" stored within the project\u2019s root directory")]),e("li",null,[t("Optional: "),e("strong",null,"Backup any custom code and extensions"),t(" within the project\u2019s root directory")]),e("li",null,[t("Optional: "),e("strong",null,"Backup your entire database"),t(", only system tables, or only project tables")]),e("li",null,[e("strong",null,"Delete the project\u2019s root directory"),t(" from the server")]),e("li",null,[e("strong",null,"Delete all Directus system tables"),t(" ("),e("code",{class:""},"directus_*"),t(") from the database")])],-1),M=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Pure SQL"),e("p",null,"After completing this process, you will be left with a pure SQL database, with no trace that Directus was ever installed. Any external services connecting to your database\u2019s project tables directly (eg: SQL queries) should continue working normally.")],-1),T=e("h2",{id:"migrating-from-v8"},[t("Migrating from v8 "),e("a",{class:"header-anchor",href:"#migrating-from-v8"},"#")],-1),S=e("p",null,"There are two ways to migrate from an existing Directus 8.X instance:",-1),U=e("ul",null,[e("li",null,[e("a",{href:"#automated-script"},"Automated Script"),t(" (recommended)")]),e("li",null,[e("a",{href:"#manual-database-export-import"},"Manual Database Export/Import")])],-1),A=e("p",null,[t("Be sure to check the "),e("a",{href:"#breaking-changes"},"Breaking changes"),t(" if you are consuming the API from an application.")],-1),F=e("h2",{id:"automated-script"},[t("Automated Script "),e("a",{class:"header-anchor",href:"#automated-script"},"#")],-1),E=e("p",null,"We created a (community maintained) script, that will automatically copy over the schema, content, files, users, and roles from an existing v8 instance to a new v9 instance. This is the most hands-off approach to moving from a v8 to a v9 instance, and is the recommended way of migrating your v8 instance.",-1),N=e("div",{class:"tip hint"},[e("p",null,[t("The script, and instructions on how to run it, can be found on the"),e("br"),e("a",{href:"https://github.com/directus-community/migration-tool",target:"_blank",rel:"noopener noreferrer"},[e("code",{class:""},"directus-community/migration-tool")]),t(" repo.")])],-1),O=e("p",null,"This tool will copy over:",-1),q=e("ul",null,[e("li",null,"Schema (collections / fields)"),e("li",null,"Files (including file contents)"),e("li",null,"User data (eg all items in all collections)"),e("li",null,"Roles"),e("li",null,"Users")],-1),C=e("p",null,[t("Due to significant differences in data structure between versions, this tool will "),e("strong",null,"NOT"),t(" copy over:")],-1),L=e("ul",null,[e("li",null,"Interface/display configurations"),e("li",null,"Permissions"),e("li",null,"Activity / revisions")],-1),Q=e("h2",{id:"manual-database-export%2Fimport"},[t("Manual Database Export/Import "),e("a",{class:"header-anchor",href:"#manual-database-export%2Fimport"},"#")],-1),R=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Automated"),e("p",null,"We highly recommend using the automated migration tool mentioned above. If that\u2019s not possible, you can perform the following steps to migrate your v8 instance.")],-1),V=e("p",null,"Directus v9 is a breaking change coming from v8 (hence the major version bump), so you won\u2019t be able to just use your existing v8 database and run v9 on top of it. However, due to the database-mirroring approach of Directus, it\u2019s fairly straightforward to migrate your content from v8 to v9.",-1),W=e("h4",{id:"1)-setup-a-fresh-v9-instance"},[t("1) Setup a Fresh v9 Instance "),e("a",{class:"header-anchor",href:"#1)-setup-a-fresh-v9-instance"},"#")],-1),z=e("p",null,"By installing Directus \u201Cfresh\u201D, you\u2019re ensured your system tables are up-to-date and ready to go.",-1),H=e("h4",{id:"2)-migrate-your-data"},[t("2) Migrate your Data "),e("a",{class:"header-anchor",href:"#2)-migrate-your-data"},"#")],-1),X=e("p",null,[t("Using a tool like "),e("a",{href:"http://sequelpro.com",target:"_blank",rel:"noopener noreferrer"},"Sequel Pro"),t(" or "),e("a",{href:"https://tableplus.com",target:"_blank",rel:"noopener noreferrer"},"TablePlus"),t(", export your v8 user-tables and import them into your v9 database.")],-1),G=e("p",null,"Directus v9 will automatically recognize your tables, and you\u2019ll be ready to get started in v9.",-1),J=e("p",null,[e("strong",null,"Note:"),t(" If you have references to users and files, make sure to update them to the new UUID format.")],-1),K=e("h4",{id:"3)-configure-directus"},[t("3) Configure Directus "),e("a",{class:"header-anchor",href:"#3)-configure-directus"},"#")],-1),Y=e("p",null,"Once the tables are in, you can start configuring the details of the schema. This includes choosing the correct interfaces, displays, and their options for your fields.",-1),Z=e("p",null,"This would also be a good time to reconfigure your permissions, to ensure they are accurate.",-1),$=e("h2",{id:"breaking-changes"},[t("Breaking changes "),e("a",{class:"header-anchor",href:"#breaking-changes"},"#")],-1),ee=t("Filter operators"),te=t(" have changed, now they are preceded with an underscore eg: "),oe=e("code",{class:""},"/items/users?filter[comments.thread.title][like]=Directus",-1),ae=t(" is now "),ne=e("code",{class:""},"/items/users?filter[comments][thread][title][_like]=Directus",-1),se={title:"Upgrades & Migrations",modularExtension:!1},re={name:"upgrades-migrations",setup(ie,{expose:i}){return i({frontmatter:{title:"Upgrades & Migrations",modularExtension:!1}}),(le,ce)=>{const a=n("router-link"),l=n("docswrapper");return c(),d(l,{frontmatter:se},{default:o(()=>[e("div",u,[e("blockquote",null,[e("p",null,[h,p,g,s(a,{to:"/docs/getting-started/glossary/#projects"},{default:o(()=>[_]),_:1}),m])]),f,y,b,v,w,k,j,D,x,B,P,I,M,T,S,U,A,F,E,N,O,q,C,L,Q,R,V,W,z,H,X,G,J,K,Y,Z,$,e("ul",null,[e("li",null,[s(a,{to:"/docs/configuration/filter-rules/"},{default:o(()=>[ee]),_:1}),te,oe,ae,ne])])])]),_:1})}}};typeof r=="function"&&r(re);export{re as default,se as frontmatter};

package/dist/assets/user-directory.47c8beb2.js

@@ -1 +0,0 @@
-import{a as n,o as d,b as c,w as t,g as e,e as i,B as s}from"./runtime-core.esm-bundler.b1f35d24.js";var l={};const u={class:"markdown-body"},h=s("The User Directory is the management system for all Users within a Project. "),p=s("Users"),_=s(" are the individual accounts for logging in to the App. Each User belongs to a "),g=s("Role"),f=s(" which defines its "),m=s("Permissions"),y=s("."),v=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/user-directory/user-directory-20220222A/user-directory-20220222A.webp",alt:"User Directory Page"})],-1),U=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#how-it-works"},"How it Works")]),e("li",null,[e("a",{href:"#user-directory-page"},"User Directory Page")]),e("li",null,[e("a",{href:"#user-details-page"},"User Details Page")]),e("li",null,[e("a",{href:"#view-a-user"},"View a User")]),e("li",null,[e("a",{href:"#create-a-user"},"Create a User")]),e("li",null,[e("a",{href:"#invite-a-user"},"Invite a User")]),e("li",null,[e("a",{href:"#edit-user-details"},"Edit User Details")]),e("li",null,[e("a",{href:"#archive-a-user"},"Archive a User")]),e("li",null,[e("a",{href:"#delete-a-user"},"Delete a User")])])])],-1),b=s(" @TODO getting-started > learn-directus :::tip Before You Begin To use this Module effectively, you will need to understand [Users, Roles and Permissions](/configuration/users-roles-permissions.md). ::: "),w=e("h2",{id:"how-it-works"},[s("How it Works "),e("a",{class:"header-anchor",href:"#how-it-works"},"#")],-1),A=e("p",null,"This Module is a management system that enables one to view, invite, create, edit, and delete Users and User information. Users can be created directly in the app, or invited to join via email.",-1),D=e("p",null,"When a User is created, they must also be assigned a Role. This Role defines the User\u2019s data access permissions within Directus. In other words, it determines what a User can see and do inside the app.",-1),T=s("The User Directory is composed of two pages: The User Directory Page and the User Details Page. It has all the same features and functionality as the "),k=s("Content Module"),P=s(" such as manual and automatic sorting, batch edit/delete/archive, import/export from files, etc."),S=e("h2",{id:"user-directory-page"},[s("User Directory Page "),e("a",{class:"header-anchor",href:"#user-directory-page"},"#")],-1),I=e("video",{title:"User Directory Options",autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/user-directory/user-directory-20220222A/user-directory-options-20220222A.mp4"}),e("p",null,[s(" Your browser is not displaying the video for some reason. Here's a "),e("a",{href:"https://cdn.directus.io/docs/v9/app-guide/user-directory/user-directory-20220222A/user-directory-options-20220222A.mp4"},"link to the video"),s(" instead. ")])],-1),C=s("The User Directory Page lists all Users in a Project, with a navigation that allows quick access to Users by Role. This page has the same functionality as the "),L=s("Collection Page"),O=s("."),x=e("li",null,[e("strong",null,"Select All"),s(" \u2014 Selects all Users currently in queue.")],-1),E=e("li",null,[e("strong",null,"Card Size"),s(" \u2014 Toggles size of User Displays.")],-1),N=e("li",null,[e("strong",null,"Sort Field"),s(" \u2014 Selects Field used to Users by.")],-1),R=e("li",null,[e("strong",null,"Sort Direction"),s(" \u2014 Toggles ascending & descending sort order.")],-1),F=e("li",null,[e("strong",null,"Search"),s(" \u2014 Enables classic type-based searching.")],-1),M=e("li",null,[e("strong",null,"Filter"),s(" \u2014 Enables advanced query-based search.")],-1),B=e("span",{mi:"",btn:"",sec:""},"person_add",-1),q=s(" \u2014 "),H=s("Invite people"),j=s(" to become Users via email."),z=e("span",{mi:"",btn:""},"add",-1),V=s(" \u2014 "),W=s("Create User"),Y=s(" manually."),K=e("p",null,[e("em",null,"The following are only visible once Users are selected.")],-1),G=e("ul",null,[e("li",null,[e("span",{mi:"",btn:"",warn:""},"edit"),s(" \u2014 Opens a User Details page to apply a single edit across multiple Users.")]),e("li",null,[e("strong",null,[e("span",{mi:"",btn:"",dngr:""},"delete")]),s(" \u2014 Deletes one or more Users.")])],-1),J=e("h3",{id:"layout-options"},[s("Layout Options "),e("a",{class:"header-anchor",href:"#layout-options"},"#")],-1),Q=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/user-directory/user-directory-20220222A/user-directory-layout-options-20220222A.webp",alt:"User Directory Layout Options"})],-1),X=s("The "),Z=e("strong",null,"Sidebar > Layout Options",-1),$=s(),ee=e("em",null,[s("(denoted by "),e("span",{mi:"",icon:""},"layers"),s(" when Sidebar is minimized)")],-1),se=s(" allows you to adjust how Users are displayed on the User Directory. To learn more, see "),te=s("Layouts"),oe=s("."),ie=e("h2",{id:"user-details-page"},[s("User Details Page "),e("a",{class:"header-anchor",href:"#user-details-page"},"#")],-1),ne=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/user-directory/user-directory-20220222A/user-profile-20220222A.webp",alt:"The User Page"})],-1),le=s("A User\u2019s profile page can be accessed from the User Directory or by clicking the User Menu at the bottom of the "),re=s("Module Bar"),ae=s(". The profile page has the same features and functionality as the "),de=s("Item Page"),ce=s(". Administrators can add and customize Fields under "),ue=s("Settings > Data Model > Directus Users"),he=s(", but the following are available by default."),pe=e("ul",null,[e("li",null,[e("strong",null,"First Name"),s(" \u2014 The given name.")]),e("li",null,[e("strong",null,"Last Name"),s(" \u2014 The family/surname.")]),e("li",null,[e("strong",null,"Email"),s(" \u2014 A unique email address.")]),e("li",null,[e("strong",null,"Password"),s(" \u2014 A hashed system password.")]),e("li",null,[e("strong",null,"Avatar"),s(" \u2014 An image to represent the User.")]),e("li",null,[e("strong",null,"Location"),s(" \u2014 The city, country, office, or branch name.")]),e("li",null,[e("strong",null,"Title"),s(" \u2014 The professional staff title.")]),e("li",null,[e("strong",null,"Description"),s(" \u2014 A freeform text description.")]),e("li",null,[e("strong",null,"Tags"),s(" \u2014 Keywords for search-ability.")])],-1),_e=e("h3",{id:"user-preferences"},[s("User Preferences "),e("a",{class:"header-anchor",href:"#user-preferences"},"#")],-1),ge=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/user-directory/user-directory-20220222A/user-preferences-20220222A.webp",alt:"User Preferences"})],-1),fe=e("ul",null,[e("li",null,[e("strong",null,"Language"),s(" \u2014 The preferred App language/locale.")]),e("li",null,[e("strong",null,"Theme"),s(" \u2014 Light or Dark mode (or based on system preferences).")]),e("li",null,[e("strong",null,"Multi-Factor Authentication"),s(" \u2014 Configuration for MFA.")]),e("li",null,[e("strong",null,"Email Notifications"),s(" \u2014 Receive emails for notifications.")])],-1),me=e("h3",{id:"admin-options"},[s("Admin Options "),e("a",{class:"header-anchor",href:"#admin-options"},"#")],-1),ye=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/user-directory/user-directory-20220222A/admin-options-20220222A.webp",alt:"Admin Options"})],-1),ve=e("li",null,[e("strong",null,"Status"),s(" \u2014 Sets User status as Draft, Invited, Active, Suspended, Archived.")],-1),Ue=e("li",null,[e("strong",null,"Role"),s(" \u2014 Defines the User\u2019s Role.")],-1),be=e("li",null,[e("strong",null,"Token"),s(" \u2014 Accepts any string as a User access token."),e("br"),e("em",null,"Note: At least 19-20 characters recommended for an access token, but we give you the flexibility to set this according to you own internal security policies.")],-1),we=e("strong",null,"Provider",-1),Ae=s(" \u2014 "),De=e("em",null,"read-only:",-1),Te=s(" SSO provider associated with User. See our built-in "),ke=s("SSO options"),Pe=s("."),Se=e("li",null,[e("strong",null,"External Identifier"),s(" \u2014 Displays external identifier generated by SSO provider.")],-1),Ie=e("h3",{id:"read-only-info"},[s("Read-only Info "),e("a",{class:"header-anchor",href:"#read-only-info"},"#")],-1),Ce=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/user-directory/user-directory-20220222A/user-profile-sidebar-information-20220309A.webp",alt:"User Profile Sidebar Information"})],-1),Le=e("p",null,[s("Information in the Sidebar "),e("em",null,[s("(denoted by "),e("span",{mi:"",icon:"",dark:""},"info"),s(" when Sidebar is minimized)")]),s(" also includes the following read-only details:")],-1),Oe=e("ul",null,[e("li",null,[e("strong",null,"User Key"),s(" \u2014 The Primary Key of the User.")]),e("li",null,[e("strong",null,"Last Page"),s(" \u2014 The last App page accessed by the User.")]),e("li",null,[e("strong",null,"Last Access"),s(" \u2014 The timestamp of the User\u2019s last App or API action.")])],-1),xe=e("h2",{id:"view-a-user"},[s("View a User "),e("a",{class:"header-anchor",href:"#view-a-user"},"#")],-1),Ee=e("video",{autoplay:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/user-directory/user-directory-20220222A/viewing-a-user-20220222A.mp4"}),e("p",null,[s(" Your browser is not displaying the video for some reason. Here's a "),e("a",{href:"https://cdn.directus.io/docs/v9/app-guide/user-directory/user-directory-20220222A/viewing-a-user-20220222A.mp4"},"link to the video"),s(" instead. ")])],-1),Ne=e("p",null,"Users are referenced throughout the app, often for accountability purposes. Hovering over a User in this context will provide a popover with basic information. Clicking that popover will navigate you to a view of that User\u2019s profile page.",-1),Re=e("h2",{id:"create-a-user"},[s("Create a User "),e("a",{class:"header-anchor",href:"#create-a-user"},"#")],-1),Fe=e("p",null,"To create a User, follow these steps:",-1),Me=e("ol",null,[e("li",null,[s("Navigate to the "),e("strong",null,"User Library"),s(".")]),e("li",null,[s("Click "),e("span",{mi:"",btn:""},"add"),s(" in the page header.")]),e("li",null,[s("Enter an "),e("strong",null,"Email Address"),s(".")]),e("li",null,"Optional: Fill in the other User details as desired."),e("li",null,[s("Click "),e("span",{mi:"",btn:""},"check"),s(" to save the User.")])],-1),Be=e("h2",{id:"invite-a-user"},[s("Invite a User "),e("a",{class:"header-anchor",href:"#invite-a-user"},"#")],-1),qe=e("p",null,"To invite User(s) via email, follow these steps:",-1),He=e("ol",null,[e("li",null,[s("Navigate to the "),e("strong",null,"User Library"),s(".")]),e("li",null,[s("Click "),e("span",{mi:"",btn:"",sec:""},"person_add"),s(" in the page header.")]),e("li",null,[s("Enter one or more email addresses, separated by a comma and a space."),e("br"),e("em",null,"Tip: You can also add emails on a new line.")]),e("li",null,[s("Select the "),e("strong",null,"Role"),s(" you want to assign to the User(s).")]),e("li",null,[s("Click "),e("strong",null,"Invite"),s(".")])],-1),je=e("p",null,"After that, the invited User(s) will receive an email with a link to the App where they set a password and enable their account.",-1),ze=e("h2",{id:"edit-user-details"},[s("Edit User Details "),e("a",{class:"header-anchor",href:"#edit-user-details"},"#")],-1),Ve=e("p",null,"To edit User details, follow these steps:",-1),We=e("ol",null,[e("li",null,[s("Navigate to the "),e("strong",null,"User Library"),s(".")]),e("li",null,"Click on the User you wish to manage and the User Details Page will open."),e("li",null,"Reset User details as desired.")],-1),Ye=e("p",null,"The User Detail is only editable by the current User and admins, and the following fields are only available to admins:",-1),Ke=e("li",null,[e("strong",null,"Status"),s(" \u2014 Determines if an account is able to access the platform or not. Only the "),e("code",{class:""},"active"),s(" state is able to authenticate, all others are simply descriptive inactive states. "),e("ul",null,[e("li",null,[e("strong",null,"Draft"),s(" \u2014 An incomplete User; no App/API access.")]),e("li",null,[e("strong",null,"Invited"),s(" \u2014 Has a pending invite to the project; no App/API access until accepted.")]),e("li",null,[e("strong",null,"Active"),s(" \u2014 The only status that has proper access to the App and API.")]),e("li",null,[e("strong",null,"Suspended"),s(" \u2014 A User that has been temporarily disabled; no App/API access.")]),e("li",null,[e("strong",null,"Archived"),s(" \u2014 A soft-deleted User; no App/API access.")])])],-1),Ge=e("li",null,[e("strong",null,"Role"),s(" \u2014 The User\u2019s role determines their permissions and access.")],-1),Je=e("strong",null,"Token",-1),Qe=s(" \u2014 A User\u2019s token is an alternate way to "),Xe=s("authenticate into the API"),Ze=s(" using a static string. When NULL, the token is disabled. When enabled, ensure that a secure string is used."),$e=e("h2",{id:"archive-a-user"},[s("Archive a User "),e("a",{class:"header-anchor",href:"#archive-a-user"},"#")],-1),es=e("p",null,"To archive a User, follow these steps:",-1),ss=e("ol",null,[e("li",null,[s("Navigate to the "),e("strong",null,"User Library"),s(".")]),e("li",null,"Click the User you with to archive to go to their User Detail page."),e("li",null,[s("Click on "),e("span",{mi:"",btn:"",warn:""},"archive"),s(" in the header.")]),e("li",null,[s("Confirm this decision by clicking "),e("strong",null,"Archive"),s(" in the dialog.")])],-1),ts=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Disables Access"),e("p",null,[s("Archiving is equivalent to a "),e("em",null,"soft-delete"),s(". These Users are unable to access the App or API.")])],-1),os=e("h2",{id:"delete-a-user"},[s("Delete a User "),e("a",{class:"header-anchor",href:"#delete-a-user"},"#")],-1),is=e("p",null,"To delete a User, follow these steps:",-1),ns=e("ol",null,[e("li",null,[s("Navigate to the "),e("strong",null,"User Library"),s(".")]),e("li",null,"Select one or more Users you wish to delete."),e("li",null,[s("Click on "),e("span",{mi:"",btn:"",dngr:""},"delete"),s(" in the header.")]),e("li",null,[s("Confirm this decision by clicking "),e("strong",null,"Delete"),s(" in the dialog.")])],-1),ls=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,[s("This action is permanent and can not be undone. Please proceed with caution. If you wish to soft-delete Users, see "),e("a",{href:"#archive-a-user"},"Archive a User"),s(".")])],-1),rs={title:"User Directory",modularExtension:!1},as={name:"user-directory",setup(ds,{expose:r}){return r({frontmatter:{title:"User Directory",modularExtension:!1}}),(cs,us)=>{const o=n("router-link"),a=n("docswrapper");return d(),c(a,{frontmatter:rs},{default:t(()=>[e("div",u,[e("blockquote",null,[e("p",null,[h,i(o,{to:"/docs/getting-started/glossary#users"},{default:t(()=>[p]),_:1}),_,i(o,{to:"/docs/getting-started/glossary#roles"},{default:t(()=>[g]),_:1}),f,i(o,{to:"/docs/getting-started/glossary#permissions"},{default:t(()=>[m]),_:1}),y])]),v,U,b,w,A,D,e("p",null,[T,i(o,{to:"/docs/app/collections"},{default:t(()=>[k]),_:1}),P]),S,I,e("p",null,[C,i(o,{to:"/docs/app/content/collections/"},{default:t(()=>[L]),_:1}),O]),e("ul",null,[x,E,N,R,F,M,e("li",null,[B,q,i(o,{to:"/docs/configuration/users-roles-permissions/#inviting-a-user"},{default:t(()=>[H]),_:1}),j]),e("li",null,[z,V,i(o,{to:"/docs/configuration/users-roles-permissions/#creating-a-user"},{default:t(()=>[W]),_:1}),Y])]),K,G,J,Q,e("p",null,[X,Z,$,ee,se,i(o,{to:"/docs/app/layouts/"},{default:t(()=>[te]),_:1}),oe]),ie,ne,e("p",null,[le,i(o,{to:"/docs/app/overview/#_1-module-bar"},{default:t(()=>[re]),_:1}),ae,i(o,{to:"/docs/app/content-items/"},{default:t(()=>[de]),_:1}),ce,i(o,{to:"/docs/configuration/data-model"},{default:t(()=>[ue]),_:1}),he]),pe,_e,ge,fe,me,ye,e("ul",null,[ve,Ue,be,e("li",null,[we,Ae,De,Te,i(o,{to:"/docs/configuration/sso"},{default:t(()=>[ke]),_:1}),Pe]),Se]),Ie,Ce,Le,Oe,xe,Ee,Ne,Re,Fe,Me,Be,qe,He,je,ze,Ve,We,Ye,e("ul",null,[Ke,Ge,e("li",null,[Je,Qe,i(o,{to:"/docs/reference/authentication/"},{default:t(()=>[Xe]),_:1}),Ze])]),$e,es,ss,ts,os,is,ns,ls])]),_:1})}}};typeof l=="function"&&l(as);export{as as default,rs as frontmatter};

package/dist/assets/users-roles-permissions.005388fa.js

@@ -1 +0,0 @@
-import{a as l,o as c,b as d,w as t,g as e,e as i,B as s}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const u={class:"markdown-body"},h=s("Users"),m=s(" are the individual accounts for authenticating into the API and App. Each user belongs to a "),p=s("Role"),f=s(" which defines its access "),_=s("Permissions"),g=s("."),w=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#overview"},"Overview")]),e("li",null,[e("a",{href:"#create-a-role"},"Create a Role")]),e("li",null,[e("a",{href:"#configure-a-role"},"Configure a Role")]),e("li",null,[e("a",{href:"#delete-a-role"},"Delete a Role")]),e("li",null,[e("a",{href:"#configure-permissions"},"Configure Permissions")]),e("li",null,[e("a",{href:"#configure-workflows"},"Configure Workflows")])])])],-1),b=s(" :::tip Before You Begin ::: "),y=e("h2",{id:"overview"},[s("Overview "),e("a",{class:"header-anchor",href:"#overview"},"#")],-1),v=e("p",null,"While this page focuses on configuration of Roles and Permissions, it is important to remember that Roles and Permissions are inherently intwined with Users. This is because every User must be assigned a Role to define their access permissions.",-1),A=e("p",null,"Directus comes with two Roles out of the box, Admin and Public. The Admin role provides full Permissions for all data in the app, and this cannot be limited. This Admin Role provides full, app-wide control to the Project owners, administrators, and creators. The Public role comes with all permissions turned off by default and these can be fully reconfigured as needed. This Public role determines the access permissions given for any unauthenticated request to app data including un-authenticated users, visitors to your website or any other web request to your Directus Project\u2019s API.",-1),P=e("p",null,"In addition, Admins can create as many Roles as they wish and configure permissions granularly.",-1),R=s(' Roles with _App Access_ enabled are created with some limited Permissions configured by default, so they can access the app and their own profile information. Roles that have neither _Admin_ nor _App Access_ enabled (such as the built-in _Public_ Role) are created with Public access permissions. ### Configure Public Permissions The Public permissions control what project data is accessible without authentication. This is managed via the Public "role", which is included in the system by default and can not be deleted. ::: warning Private by Default All of the data within the platform is private by default. Permissions for the public role can be granted on a case-by-case basis by administrators. ::: '),k=e("h2",{id:"create-a-role"},[s("Create a Role "),e("a",{class:"header-anchor",href:"#create-a-role"},"#")],-1),C=e("ol",null,[e("li",null,[s("Navigate to "),e("strong",null,[s("Settings "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),s(" Roles & Permissions")])]),e("li",null,[s("Click "),e("span",{mi:"",btn:""},"add"),s(" in the header")]),e("li",null,[s("Enter a unique "),e("strong",null,"Role Name")]),e("li",null,[s("Enabling "),e("strong",null,"App Access"),s(" allows logging in to the App")]),e("li",null,[s("Enabling "),e("strong",null,"Admin Access"),s(" gives full permission to project data and Settings")]),e("li",null,[s("Click on "),e("strong",null,"Save"),s(" to save the role")])],-1),T=e("h2",{id:"configure-a-role"},[s("Configure a Role "),e("a",{class:"header-anchor",href:"#configure-a-role"},"#")],-1),F=e("ul",null,[e("li",null,[e("strong",null,"Permissions"),s(" \u2014 Configure "),e("a",{href:"#configure-permissions"},"access permissions"),s(" for the role")]),e("li",null,[e("strong",null,"Role Name"),s(" \u2014 This is the name of the role")]),e("li",null,[e("strong",null,"Role Icon"),s(" \u2014 The icon used throughout the App when referencing this role")]),e("li",null,[e("strong",null,"Description"),s(" \u2014 A helpful note that explains the role\u2019s purpose")]),e("li",null,[e("strong",null,"App Access"),s(" \u2014 Allows logging in to the App")]),e("li",null,[e("strong",null,"Admin Access"),s(" \u2014 Gives full permission to project data and Settings")]),e("li",null,[e("strong",null,"IP Access"),s(" \u2014 An allow-list of IP addresses from which the platform can be accessed, empty allows all")]),e("li",null,[e("strong",null,"Require 2FA"),s(" \u2014 Forces all users within this role to use two-factor authentication")]),e("li",null,[e("strong",null,"Users in Role"),s(" \u2014 A list of all users within this role")])],-1),S=e("h2",{id:"delete-a-role"},[s("Delete a Role "),e("a",{class:"header-anchor",href:"#delete-a-role"},"#")],-1),x=e("ol",null,[e("li",null,[s("Navigate to "),e("strong",null,[s("Settings "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),s(" Roles & Permissions "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),s(" [Role Name]")])]),e("li",null,[s("Click "),e("span",{mi:"",btn:"",dngr:""},"delete"),s(" in the header")]),e("li",null,[s("Confirm this decision by clicking "),e("strong",null,"Delete"),s(" in the dialog")])],-1),D=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Users in a Deleted Role"),e("p",null,[s("If you delete a role that still has users in it, those users will be given a "),e("code",{class:""},"NULL"),s(" role, which denies their App access and limits them to Public permissions. They can then be reassigned to a new role by an admin.")])],-1),I=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Last Admin"),e("p",null,"You must maintain at least one role/user with Admin Access so that you can still properly manage the project.")],-1),N=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Public Role"),e("p",null,"You can not delete the Public role, as it is part of the core platform. To disable it completely, simply turn off all Public access permissions.")],-1),U=e("h2",{id:"configure-permissions"},[s("Configure Permissions "),e("a",{class:"header-anchor",href:"#configure-permissions"},"#")],-1),q=e("p",null,"Directus possesses an extremely granular, yet easy to configure, permissions system. When creating a new role, permissions are disabled for all project collections by default \u2014 allowing you to give explicit access to only what is required. Individual permissions are applied to the role, and each is scoped to a specific collection and CRUD action (create, read, update, delete).",-1),j=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Saves Automatically"),e("p",null,"Every change made to the permissions of a role is saved automatically and instantly.")],-1),E=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Admin Roles"),e("p",null,[s("If a role is set to "),e("strong",null,"Admin Access"),s(" then it is granted complete access to the platform, and Permission configuration is disabled.")])],-1),B=e("ol",null,[e("li",null,[s("Navigate to "),e("strong",null,[s("Settings "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),s(" Roles & Permissions "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),s(" [Role Name]")])]),e("li",null,[s("Scroll to the "),e("strong",null,"Permissions"),s(" section")]),e("li",null,[e("strong",null,"Click the icon"),s(" for the collection (row) and action (column) you want to set")]),e("li",null,[s("Choose the desired permission level: "),e("span",{mi:"",icon:""},"check"),s(),e("strong",null,"All Access"),s(", "),e("span",{mi:"",icon:""},"block"),s(),e("strong",null,"No Access"),s(", or "),e("span",{mi:"",icon:""},"rule"),s(),e("strong",null,"Use Custom")])],-1),W=e("p",null,[s("If you selected "),e("strong",null,[s("\u201C"),e("span",{mi:"",icon:""},"check"),s(" All Access\u201D")]),s(" or "),e("strong",null,[s("\u201C"),e("span",{mi:"",icon:""},"block"),s(" No Access\u201D")]),s(" then setup is complete. If you chose to customize permissions then continue with the appropriate guide below based on the relevant "),e("em",null,"action"),s(".")],-1),V=e("h3",{id:"create-(custom-access)"},[s("Create (Custom Access) "),e("a",{class:"header-anchor",href:"#create-(custom-access)"},"#")],-1),Y=e("ol",{start:"5"},[e("li",null,[e("strong",null,"Field Permissions"),s(" control which fields accept a value on create. Fields are individually toggled.")]),e("li",null,[e("strong",null,"Field Validation"),s(" define the rules for field values on create")]),e("li",null,[e("strong",null,"Field Presets"),s(" control the field defaults when creating an item")])],-1),L=e("h3",{id:"read-(custom-access)"},[s("Read (Custom Access) "),e("a",{class:"header-anchor",href:"#read-(custom-access)"},"#")],-1),M={start:"5"},z=e("strong",null,"Item Permissions",-1),G=s(" control which items can be read, as defined by the "),O=s("Filter Rules"),K=s(" entered."),H=e("li",null,[e("strong",null,"Field Permissions"),s(" control which fields can be read. Fields are individually toggled.")],-1),J=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Read Field Permissions"),e("p",null,[s("The Directus App always requires read access to the Primary Key field (eg: "),e("code",{class:""},"id"),s(") so it can uniquely identify items. Also, if a Collection has \u201CArchive\u201D or \u201CSort\u201D fields configured, those fields will also need read access to use the App\u2019s soft-delete and manual sorting features.")])],-1),Q=e("h3",{id:"update-(custom-access)"},[s("Update (Custom Access) "),e("a",{class:"header-anchor",href:"#update-(custom-access)"},"#")],-1),X={start:"5"},Z=e("strong",null,"Item Permissions",-1),$=s(" control which items can be updated, as defined by "),ee=s("Filter Rules"),se=s("."),te=e("li",null,[e("strong",null,"Field Permissions"),s(" control which fields can be updated. Fields are individually toggled.")],-1),oe=e("strong",null,"Field Validation",-1),ie=s(" define the rules for field values on update, as defined by "),le=s("Filter Rules"),ne=s("."),ae=e("li",null,[e("strong",null,"Field Presets"),s(" control the field defaults when updating an item")],-1),re=e("h3",{id:"delete-(custom-access)"},[s("Delete (Custom Access) "),e("a",{class:"header-anchor",href:"#delete-(custom-access)"},"#")],-1),ce={start:"5"},de=e("strong",null,"Item Permissions",-1),ue=s(" control which items can be deleted, as defined by the "),he=s("Filter Rules"),me=s(" entered."),pe=e("hr",null,null,-1),fe=e("h3",{id:"configure-system-permissions"},[s("Configure System Permissions "),e("a",{class:"header-anchor",href:"#configure-system-permissions"},"#")],-1),_e=e("p",null,[s("In addition to permissions for "),e("em",null,"your"),s(" custom collections, you can also customize the permissions for "),e("em",null,"system"),s(" collections. To edit system permissions, follow these steps:")],-1),ge=e("ol",null,[e("li",null,[s("Go to "),e("strong",null,"Roles and Permissions"),s(" and select the desired Role."),e("br"),e("em",null,"You will be taken to the permissions configuration page.")]),e("li",null,[s("Click "),e("strong",null,"System Collections"),s(" at the bottom of the page.")]),e("li",null,"Find the desired System Collection."),e("li",null,"Set permissions as desired.")],-1),we=e("p",null,"There are two pre-configured options you can use for resetting the role\u2019s system permissions and ensure proper App access. To access these, click \u201CSystem Collections\u201D to expand, and then click one of the buttons at the bottom of the listing.",-1),be=e("ul",null,[e("li",null,[e("strong",null,"App Access Minimum"),s(" \u2014 The minimum permissions required to properly access the App")]),e("li",null,[e("strong",null,"Recommended Defaults"),s(" \u2014 More permissive but balanced for a better App user experience")])],-1),ye=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Remember"),e("p",null,[s("When App Access is enabled, Directus will automatically add "),e("em",null,"(and hardcode)"),s(" permissions for the necessary system collections for that Role.")])],-1),ve=e("h2",{id:"configure-workflows"},[s("Configure Workflows "),e("a",{class:"header-anchor",href:"#configure-workflows"},"#")],-1),Ae=e("p",null,"Workflows are a way to add structured stages to the flow of content authoring. They are primarily defined through the permissions for a Collection, but can be further enhanced via email notifications, custom interfaces, and automation. Directus supports endlessly configurable workflows, so we will only cover one simple example below.",-1),Pe=s("To create a structured workflow for "),Re=e("strong",null,"Articles",-1),ke=s(", the first step is "),Ce=s("Creating a Field"),Te=s(" to track the article \u201Cstatus\u201D \u2014 we\u2019ll call it "),Fe=e("strong",null,"Status",-1),Se=s(", but it can be named anything."),xe=e("li",null,[s("Next, create different Roles for each stage of the workflow, such as "),e("code",{class:""},"author"),s(" and "),e("code",{class:""},"manager"),s(".")],-1),De=e("li",null,[s("Finally, configure the Role permissions based on the possible values of that Status field, such as "),e("code",{class:""},"draft"),s(", "),e("code",{class:""},"review"),s(", "),e("code",{class:""},"approved"),s(", and "),e("code",{class:""},"published"),s(", so that they are properly restricted to create content and update the status. "),e("ul",null,[e("li",null,[s("The Author can create content, but only save a status of "),e("code",{class:""},"draft"),s(" or "),e("code",{class:""},"review"),s(".")]),e("li",null,[s("The Manager has additional permissions that allow them to save statuses of "),e("code",{class:""},"approved"),s(" or "),e("code",{class:""},"published"),s(".")])])],-1),Ie={title:"Users, Roles & Permissions",modularExtension:!1},Ne={name:"users-roles-permissions",setup(Ue,{expose:a}){return a({frontmatter:{title:"Users, Roles & Permissions",modularExtension:!1}}),(qe,je)=>{const o=l("router-link"),r=l("docswrapper");return c(),d(r,{frontmatter:Ie},{default:t(()=>[e("div",u,[e("blockquote",null,[e("p",null,[i(o,{to:"/docs/getting-started/glossary/#users"},{default:t(()=>[h]),_:1}),m,i(o,{to:"/docs/getting-started/glossary/#roles"},{default:t(()=>[p]),_:1}),f,i(o,{to:"/docs/getting-started/glossary/#permissions"},{default:t(()=>[_]),_:1}),g])]),w,b,y,v,A,P,R,k,C,T,F,S,x,D,I,N,U,q,j,E,B,W,V,Y,L,e("ol",M,[e("li",null,[z,G,i(o,{to:"/docs/configuration/filter-rules"},{default:t(()=>[O]),_:1}),K]),H]),J,Q,e("ol",X,[e("li",null,[Z,$,i(o,{to:"/docs/configuration/filter-rules/"},{default:t(()=>[ee]),_:1}),se]),te,e("li",null,[oe,ie,i(o,{to:"/docs/configuration/filter-rules/"},{default:t(()=>[le]),_:1}),ne]),ae]),re,e("ol",ce,[e("li",null,[de,ue,i(o,{to:"/docs/configuration/filter-rules/"},{default:t(()=>[he]),_:1}),me])]),pe,fe,_e,ge,we,be,ye,ve,Ae,e("ol",null,[e("li",null,[Pe,Re,ke,i(o,{to:"/docs/configuration/data-model/#creating-a-field"},{default:t(()=>[Ce]),_:1}),Te,Fe,Se]),xe,De])])]),_:1})}}};typeof n=="function"&&n(Ne);export{Ne as default,Ie as frontmatter};

package/dist/assets/users.84251ab9.js

@@ -1,252 +0,0 @@
-import{a as r,o as h,b as i,w as a,g as s,e as l,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const d={class:"markdown-body"},u={class:"two-up"},p={class:"left"},_=e("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. "),g=e("Learn more about Users"),f=e("."),m=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-user-object"},"The User Object")]),s("li",null,[s("a",{href:"#list-users"},"List Users")]),s("li",null,[s("a",{href:"#retrieve-a-user"},"Retrieve a User")]),s("li",null,[s("a",{href:"#retrieve-the-current-user"},"Retrieve the Current User")]),s("li",null,[s("a",{href:"#update-the-current-user"},"Update the Current User")]),s("li",null,[s("a",{href:"#create-a-user"},"Create a User")]),s("li",null,[s("a",{href:"#create-multiple-users"},"Create Multiple Users")]),s("li",null,[s("a",{href:"#update-a-user"},"Update a User")]),s("li",null,[s("a",{href:"#update-multiple-users"},"Update Multiple Users")]),s("li",null,[s("a",{href:"#delete-a-user"},"Delete a User")]),s("li",null,[s("a",{href:"#delete-multiple-users"},"Delete Multiple Users")]),s("li",null,[s("a",{href:"#invite-a-new-user"},"Invite a new User")]),s("li",null,[s("a",{href:"#accept-user-invite"},"Accept User Invite")]),s("li",null,[s("a",{href:"#generate-two-factor-authentication-secret"},"Generate Two-Factor Authentication Secret")]),s("li",null,[s("a",{href:"#enable-two-factor-authentication"},"Enable Two-Factor Authentication")]),s("li",null,[s("a",{href:"#disable-two-factor-authentication"},"Disable Two-Factor Authentication")])])])])],-1),j=s("hr",null,null,-1),y=s("h2",{id:"the-user-object"},[e("The User Object "),s("a",{class:"header-anchor",href:"#the-user-object"},"#")],-1),b={class:"two-up"},q={class:"left"},v={class:"definitions"},w=s("p",null,[s("code",{class:""},"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the user.")],-1),x=s("p",null,[s("code",{class:""},"first_name"),e(),s("strong",null,"string"),s("br"),e(" First name of the user.")],-1),T=s("p",null,[s("code",{class:""},"last_name"),e(),s("strong",null,"string"),s("br"),e(" Last name of the user.")],-1),R=s("p",null,[s("code",{class:""},"email"),e(),s("strong",null,"string"),s("br"),e(" Email address of the user.")],-1),E=s("p",null,[s("code",{class:""},"password"),e(),s("strong",null,"hash"),s("br"),e(" Password of the user.")],-1),S=s("p",null,[s("code",{class:""},"location"),e(),s("strong",null,"string"),s("br"),e(" Location of the user.")],-1),P=s("p",null,[s("code",{class:""},"title"),e(),s("strong",null,"string"),s("br"),e(" Title of the user.")],-1),k=s("p",null,[s("code",{class:""},"description"),e(),s("strong",null,"string"),s("br"),e(" Description of the user.")],-1),A=s("p",null,[s("code",{class:""},"tags"),e(),s("strong",null,"csv"),s("br"),e(" Tags for the user.")],-1),U=s("code",{class:""},"avatar",-1),O=e(),L=s("strong",null,"many-to-one",-1),C=s("br",null,null,-1),I=e(" Avatar file. Many-to-one to "),Q=e("files"),G=e("."),B=s("p",null,[s("code",{class:""},"language"),e(),s("strong",null,"string"),s("br"),e(" Language the Admin App is rendered in. See "),s("a",{href:"https://locales.directus.io",target:"_blank",rel:"noopener noreferrer"},"our Crowdin page"),e(" for all available languages and translations.")],-1),D=s("p",null,[s("code",{class:""},"theme"),e(),s("strong",null,"string"),s("br"),e(" One of "),s("code",{class:""},"auto"),e(", "),s("code",{class:""},"light"),e(", "),s("code",{class:""},"dark"),e(".")],-1),M=s("p",null,[s("code",{class:""},"tfa_secret"),e(),s("strong",null,"string"),s("br"),e(" When TFA is enabled, this holds the secret key for it.")],-1),F=s("p",null,[s("code",{class:""},"status"),e(),s("strong",null,"string"),s("br"),e(" Status of the user. One of "),s("code",{class:""},"draft"),e(", "),s("code",{class:""},"invited"),e(", "),s("code",{class:""},"active"),e(", "),s("code",{class:""},"suspended"),e(", "),s("code",{class:""},"archived"),e(".")],-1),H=s("code",{class:""},"role",-1),N=e(),V=s("strong",null,"uuid",-1),W=s("br",null,null,-1),Y=e(" Role of the user. Many-to-one to "),z=e("roles"),J=e("."),K=s("p",null,[s("code",{class:""},"token"),e(),s("strong",null,"string"),s("br"),e(" Static access token for the user.")],-1),X=s("p",null,[s("code",{class:""},"last_access"),e(),s("strong",null,"date"),s("br"),e(" Last time the user accessed the API.")],-1),Z=s("p",null,[s("code",{class:""},"last_page"),e(),s("strong",null,"string"),s("br"),e(" Last page in the app the user used.")],-1),$=s("p",null,[s("code",{class:""},"provider"),e(),s("strong",null,"string"),s("br"),e(" What auth provider was used to register this user.")],-1),ss=s("p",null,[s("code",{class:""},"external_identifier"),e(),s("strong",null,"string"),s("br"),e(" Primary key of the user in the third party authentication provider, if used.")],-1),es=s("p",null,[s("code",{class:""},"auth_data"),e(),s("strong",null,"json"),s("br"),e(" Required data about the user as provided by the third party auth provider, if used.")],-1),as=s("p",null,[s("code",{class:""},"email_notifications"),e(),s("strong",null,"boolean"),s("br"),e(" When this is enabled, the user will receive emails for notifications.")],-1),ts=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
-	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"first_name"'),e(": "),s("span",{class:"hljs-string"},'"Admin"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"last_name"'),e(": "),s("span",{class:"hljs-string"},'"User"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"admin@example.com"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"**********"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"location"'),e(": "),s("span",{class:"hljs-string"},'"New York City"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"title"'),e(": "),s("span",{class:"hljs-string"},'"CTO"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"description"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"tags"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"avatar"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"language"'),e(": "),s("span",{class:"hljs-string"},'"en-US"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"theme"'),e(": "),s("span",{class:"hljs-string"},'"auto"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"tfa_secret"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"token"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"last_access"'),e(": "),s("span",{class:"hljs-string"},'"2021-02-05T10:18:13-05:00"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"last_page"'),e(": "),s("span",{class:"hljs-string"},'"/settings/roles/653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(`
-}
-`)])])],-1),ls=s("hr",null,null,-1),rs=s("h2",{id:"list-users"},[e("List Users "),s("a",{class:"header-anchor",href:"#list-users"},"#")],-1),ns=s("p",null,"List all users that exist in Directus.",-1),cs={class:"two-up"},os={class:"left"},hs=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),is=e("Supports all "),ds=e("global query parameters"),us=e("."),ps=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),_s=e("An array of up to "),gs=e("limit"),fs=e(),ms=s("a",{href:"#the-user-object"},"user objects",-1),js=e(". If no items are available, data will be an empty array."),ys={class:"right"},bs=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),qs=s("pre",null,[s("code",{class:""},`GET /users
-SEARCH /users
-`)],-1),vs=e("Learn more about SEARCH ->"),ws=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),xs=s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)],-1),Ts=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	users: [directus_users]
-}
-`)])],-1),Rs=s("h5",{id:"example"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),Es=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	users {
-		first_name
-		last_name
-		email
-	}
-}
-`)])],-1),Ss=s("hr",null,null,-1),Ps=s("h2",{id:"retrieve-a-user"},[e("Retrieve a User "),s("a",{class:"header-anchor",href:"#retrieve-a-user"},"#")],-1),ks=s("p",null,"List an existing user by primary key.",-1),As={class:"two-up"},Us={class:"left"},Os=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Ls=e("Supports all "),Cs=e("global query parameters"),Is=e("."),Qs=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),Gs=s("p",null,[e("Returns the requested "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),Bs=s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",{class:""},`GET /users/:id
-`)]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:""},`GET /users/72a1ce24-4748-47de-a05f-ce9af3033727
-`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	users_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_users
-}
-`)])]),s("h5",{id:"example-3"},[e("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	users_by_id(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(`) {
-		first_name
-		last_name
-		email
-	}
-}
-`)])])],-1),Ds=s("hr",null,null,-1),Ms=s("h2",{id:"retrieve-the-current-user"},[e("Retrieve the Current User "),s("a",{class:"header-anchor",href:"#retrieve-the-current-user"},"#")],-1),Fs=s("p",null,"Retrieve the currently authenticated user.",-1),Hs={class:"two-up"},Ns={class:"left"},Vs=s("h3",{id:"query-parameters-3"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Ws=e("Supports all "),Ys=e("global query parameters"),zs=e("."),Js=s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Ks=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the currently authenticated user.")],-1),Xs=s("div",{class:"right"},[s("h3",{id:"rest-api-3"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",{class:""},`GET /users/me
-`)]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	users_me: directus_users
-}
-`)])]),s("h5",{id:"example-4"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	users_me {
-		email
-	}
-}
-`)])])],-1),Zs=s("hr",null,null,-1),$s=s("h2",{id:"update-the-current-user"},[e("Update the Current User "),s("a",{class:"header-anchor",href:"#update-the-current-user"},"#")],-1),se=s("p",null,"Update the authenticated user.",-1),ee={class:"two-up"},ae={class:"left"},te=s("h3",{id:"query-parameters-4"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),le=e("Supports all "),re=e("global query parameters"),ne=e("."),ce=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),oe=s("p",null,[e("Returns the updated "),s("a",{href:"#the-user-object"},"user object"),e(" for the authenticated user.")],-1),he=s("div",{class:"right"},[s("h3",{id:"rest-api-4"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",{class:""},`PATCH /users/me
-`)]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /users/me"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"new.email@example.com"'),e(`
-}
-`)])]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	update_users_me(data: update_directus_users_input!): directus_users
-}
-`)])]),s("h5",{id:"example-5"},[e("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	update_users_me(data: { email: `),s("span",{class:"hljs-string"},'"new.email@example.com"'),e(` }) {
-		email
-	}
-}
-`)])])],-1),ie=s("hr",null,null,-1),de=s("h2",{id:"create-a-user"},[e("Create a User "),s("a",{class:"header-anchor",href:"#create-a-user"},"#")],-1),ue=s("p",null,"Create a new user",-1),pe={class:"two-up"},_e={class:"left"},ge=s("h3",{id:"query-parameters-5"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),fe=e("Supports all "),me=e("global query parameters"),je=e("."),ye=s("h3",{id:"request-body"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),be=s("p",null,[e("A partial "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),qe=s("p",null,[s("code",{class:""},"email"),e(" and "),s("code",{class:""},"password"),e(" are required.")],-1),ve=s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),we=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the created user.")],-1),xe=s("div",{class:"right"},[s("h3",{id:"rest-api-5"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",{class:""},`POST /users
-`)]),s("h5",{id:"example-6"},[e("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"another@example.com"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
-}
-`)])]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	create_users_item(data: create_directus_users_input!): directus_users
-}
-`)])]),s("h5",{id:"example-7"},[e("Example "),s("a",{class:"header-anchor",href:"#example-7"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	create_users_item(
-		data: { email: `),s("span",{class:"hljs-string"},'"another@example.com"'),e(", password: "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(` }
-	) {
-		email
-		role
-	}
-}
-`)])])],-1),Te=s("hr",null,null,-1),Re=s("h2",{id:"create-multiple-users"},[e("Create Multiple Users "),s("a",{class:"header-anchor",href:"#create-multiple-users"},"#")],-1),Ee=s("p",null,"Create multiple new users",-1),Se={class:"two-up"},Pe={class:"left"},ke=s("h3",{id:"query-parameters-6"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),Ae=e("Supports all "),Ue=e("global query parameters"),Oe=e("."),Le=s("h3",{id:"request-body-2"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Ce=s("p",null,[e("An array of partial "),s("a",{href:"#the-user-object"},"user objects"),e(".")],-1),Ie=s("p",null,[s("code",{class:""},"email"),e(" and "),s("code",{class:""},"password"),e(" are required.")],-1),Qe=s("h3",{id:"returns-6"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Ge=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user objects"),e(" for the created users.")],-1),Be=s("div",{class:"right"},[s("h3",{id:"rest-api-6"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",{class:""},`POST /users
-`)]),s("h5",{id:"example-8"},[e("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users"),e(`
-
-[
-	{
-		`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"admin@example.com"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"p455w0rd"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
-	},
-	{
-		`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"another@example.com"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
-	}
-]
-`)])]),s("h3",{id:"graphql-6"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	create_users_items(data: [create_directus_users_input!]!): [directus_users]
-}
-`)])]),s("h5",{id:"example-9"},[e("Example "),s("a",{class:"header-anchor",href:"#example-9"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	create_users_items(
-		data: [
-			{ email: `),s("span",{class:"hljs-string"},'"admin@example.com"'),e(", password: "),s("span",{class:"hljs-string"},'"p455w0rd"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(` }
-			{ email: `),s("span",{class:"hljs-string"},'"another@example.com"'),e(", password: "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(` }
-		]
-	) {
-		email
-		role
-	}
-}
-`)])])],-1),De=s("hr",null,null,-1),Me=s("h2",{id:"update-a-user"},[e("Update a User "),s("a",{class:"header-anchor",href:"#update-a-user"},"#")],-1),Fe=s("p",null,"Update an existing user.",-1),He={class:"two-up"},Ne={class:"left"},Ve=s("h3",{id:"query-parameters-7"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-7"},"#")],-1),We=e("Supports all "),Ye=e("global query parameters"),ze=e("."),Je=s("h3",{id:"request-body-3"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),Ke=s("p",null,[e("A partial "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),Xe=s("h3",{id:"returns-7"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-7"},"#")],-1),Ze=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the updated user.")],-1),$e=s("div",{class:"right"},[s("h3",{id:"rest-api-7"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",{class:""},`PATCH /users/:id
-`)]),s("h5",{id:"example-10"},[e("Example "),s("a",{class:"header-anchor",href:"#example-10"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /users/72a1ce24-4748-47de-a05f-ce9af3033727"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"title"'),e(": "),s("span",{class:"hljs-string"},'"CTO"'),e(`
-}
-`)])]),s("h3",{id:"graphql-7"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	update_users_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_users_input!): directus_users
-}
-`)])]),s("h5",{id:"example-11"},[e("Example "),s("a",{class:"header-anchor",href:"#example-11"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	update_users_item(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", data: { title: "),s("span",{class:"hljs-string"},'"CTO"'),e(` }) {
-		first_name
-		last_name
-	}
-}
-`)])])],-1),sa=s("hr",null,null,-1),ea=s("h2",{id:"update-multiple-users"},[e("Update Multiple Users "),s("a",{class:"header-anchor",href:"#update-multiple-users"},"#")],-1),aa=s("p",null,"Update multiple existing users.",-1),ta={class:"two-up"},la={class:"left"},ra=s("h3",{id:"query-parameters-8"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-8"},"#")],-1),na=e("Supports all "),ca=e("global query parameters"),oa=e("."),ha=s("h3",{id:"request-body-4"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),ia=s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the users you\u2019d like to update.")]),s("p",null,[s("code",{class:""},"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-user-object"},"the user object"),e("\u2019s properties.")])],-1),da=s("h3",{id:"returns-8"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-8"},"#")],-1),ua=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user objects"),e(" for the updated users.")],-1),pa=s("div",{class:"right"},[s("h3",{id:"rest-api-8"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),s("pre",null,[s("code",{class:""},`PATCH /users
-`)]),s("h5",{id:"example-12"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /users"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"keys"'),e(": ["),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", "),s("span",{class:"hljs-string"},'"9c3d75a8-7a5f-41a4-be0a-1488fd974511"'),e(`],
-	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"title"'),e(": "),s("span",{class:"hljs-string"},'"CTO"'),e(`
-	}
-}
-`)])]),s("h3",{id:"graphql-8"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-8"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	update_users_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_users_input!): [directus_users]
-}
-`)])]),s("h5",{id:"example-13"},[e("Example "),s("a",{class:"header-anchor",href:"#example-13"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	update_users_items(
-		ids: [`),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", "),s("span",{class:"hljs-string"},'"9c3d75a8-7a5f-41a4-be0a-1488fd974511"'),e(`]
-		data: { title: `),s("span",{class:"hljs-string"},'"CTO"'),e(` }
-	) {
-		first_name
-		last_name
-	}
-}
-`)])])],-1),_a=s("hr",null,null,-1),ga=s("h2",{id:"delete-a-user"},[e("Delete a User "),s("a",{class:"header-anchor",href:"#delete-a-user"},"#")],-1),fa=s("p",null,"Delete an existing user.",-1),ma=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-9"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-9"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-9"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-9"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /users/:id
-`)]),s("h5",{id:"example-14"},[e("Example "),s("a",{class:"header-anchor",href:"#example-14"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /users/72a1ce24-4748-47de-a05f-ce9af3033727
-`)]),s("h3",{id:"graphql-9"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-9"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	delete_users_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
-}
-`)])]),s("h5",{id:"example-15"},[e("Example "),s("a",{class:"header-anchor",href:"#example-15"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	delete_users_item(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(`) {
-		id
-	}
-}
-`)])])])],-1),ja=s("hr",null,null,-1),ya=s("h2",{id:"delete-multiple-users"},[e("Delete Multiple Users "),s("a",{class:"header-anchor",href:"#delete-multiple-users"},"#")],-1),ba=s("p",null,"Delete multiple existing users.",-1),qa=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-5"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"An array of user primary keys"),s("h3",{id:"returns-10"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-10"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-10"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-10"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /users
-`)]),s("h5",{id:"example-16"},[e("Example "),s("a",{class:"header-anchor",href:"#example-16"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// Request"),e(`
-[`),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(", "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`]
-`)])]),s("h3",{id:"graphql-10"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-10"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	delete_users_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
-}
-`)])]),s("h5",{id:"example-17"},[e("Example "),s("a",{class:"header-anchor",href:"#example-17"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	delete_users_items(ids: [`),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", "),s("span",{class:"hljs-string"},'"9c3d75a8-7a5f-41a4-be0a-1488fd974511"'),e(`]) {
-		ids
-	}
-}
-`)])])])],-1),va=s("hr",null,null,-1),wa=s("h2",{id:"invite-a-new-user"},[e("Invite a new User "),s("a",{class:"header-anchor",href:"#invite-a-new-user"},"#")],-1),xa=s("p",null,"Invite a new user by email.",-1),Ta={class:"two-up"},Ra={class:"left"},Ea=s("h3",{id:"request-body-6"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-6"},"#")],-1),Sa={class:"definitions"},Pa=s("p",null,[s("code",{class:""},"email"),e(),s("strong",null,"Required"),s("br"),e(" User email to invite.")],-1),ka=s("p",null,[s("code",{class:""},"role"),e(),s("strong",null,"Required"),s("br"),e(" Role of the new user.")],-1),Aa=s("code",{class:""},"invite_url",-1),Ua=s("br",null,null,-1),Oa=e(" Provide a custom invite url which the link in the email will lead to. The invite token will be passed as a parameter."),La=s("br",null,null,-1),Ca=s("strong",null,"Note",-1),Ia=e(": You need to configure the "),Qa=s("code",{class:""},"USER_INVITE_URL_ALLOW_LIST",-1),Ga=e(" environment variable"),Ba=e(" to enable this feature."),Da=s("h3",{id:"returns-11"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-11"},"#")],-1),Ma=s("p",null,"Empty body.",-1),Fa=s("div",{class:"right"},[s("h3",{id:"rest-api-11"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-11"},"#")]),s("pre",null,[s("code",{class:""},`POST /users/invite
-`)]),s("h5",{id:"example-18"},[e("Example "),s("a",{class:"header-anchor",href:"#example-18"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/invite"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"another@example.com"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
-}
-`)])]),s("h3",{id:"graphql-11"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-11"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	users_invite(email:`),s("span",{class:"hljs-type"}," String"),e("!, role:"),s("span",{class:"hljs-type"}," String"),e("!, invite_url:"),s("span",{class:"hljs-type"}," String"),e("):"),s("span",{class:"hljs-type"}," Boolean"),e(`
-}
-`)])]),s("h5",{id:"example-19"},[e("Example "),s("a",{class:"header-anchor",href:"#example-19"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	users_invite(email: `),s("span",{class:"hljs-string"},'"another@example.com"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`)
-}
-`)])])],-1),Ha=s("hr",null,null,-1),Na=s("h2",{id:"accept-user-invite"},[e("Accept User Invite "),s("a",{class:"header-anchor",href:"#accept-user-invite"},"#")],-1),Va=s("p",null,[e("Accept your invite. The "),s("a",{href:"#invite-a-new-user"},"invite user endpoint"),e(" sends the email a link to the Admin App.")],-1),Wa=s("p",null,"This link includes a token, which is then used to activate the invited user.",-1),Ya=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-7"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-7"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"token"),e(),s("strong",null,"Required"),s("br"),e(" Accept invite token.")]),s("p",null,[s("code",{class:""},"password"),e(),s("strong",null,"Required"),s("br"),e(" Password for the user.")])]),s("h3",{id:"returns-12"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-12"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-12"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-12"},"#")]),s("pre",null,[s("code",{class:""},`POST /users/invite/accept
-`)]),s("h5",{id:"example-20"},[e("Example "),s("a",{class:"header-anchor",href:"#example-20"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/invite/accept"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"token"'),e(": "),s("span",{class:"hljs-string"},'"eyJh...KmUk"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`
-}
-`)])]),s("h3",{id:"graphql-12"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-12"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	users_invite_accept(token:`),s("span",{class:"hljs-type"}," String"),e("!, password:"),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
-}
-`)])]),s("h5",{id:"example-21"},[e("Example "),s("a",{class:"header-anchor",href:"#example-21"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	users_invite_accept(token: `),s("span",{class:"hljs-string"},'"eyJh...KmUk"'),e(", password: "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`)
-}
-`)])])])],-1),za=s("hr",null,null,-1),Ja=s("h2",{id:"generate-two-factor-authentication-secret"},[e("Generate Two-Factor Authentication Secret "),s("a",{class:"header-anchor",href:"#generate-two-factor-authentication-secret"},"#")],-1),Ka=s("p",null,"Generates a secret and returns the URL to be used in an authenticator app.",-1),Xa=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-8"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-8"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"password"),e(),s("strong",null,"Required"),s("br"),e(" The user\u2019s password.")])]),s("h3",{id:"returns-13"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-13"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"secret"),e(),s("strong",null,"string"),s("br"),e(" OTP secret to be saved in the authenticator app.")]),s("p",null,[s("code",{class:""},"otpauth_url"),e(),s("strong",null,"string"),s("br"),s("code",{class:""},"otpauth://"),e(" formatted URL. Can be rendered as QR code and used in most authenticator apps.")])])]),s("div",{class:"right"},[s("h3",{id:"rest-api-13"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-13"},"#")]),s("pre",null,[s("code",{class:""},`POST /users/me/tfa/generate
-`)]),s("h5",{id:"example-22"},[e("Example "),s("a",{class:"header-anchor",href:"#example-22"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/me/tfa/generate"),e(`
-{
-	`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`
-}
-`)])]),s("h3",{id:"graphql-13"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-13"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	users_me_tfa_generate(password:`),s("span",{class:"hljs-type"}," String"),e(`!): users_me_tfa_generate_data
-}
-`)])]),s("h5",{id:"example-23"},[e("Example "),s("a",{class:"header-anchor",href:"#example-23"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	users_me_tfa_generate(password: `),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`) {
-		secret
-		otpauth_url
-	}
-}
-`)])])])],-1),Za=s("hr",null,null,-1),$a=s("h2",{id:"enable-two-factor-authentication"},[e("Enable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#enable-two-factor-authentication"},"#")],-1),st=s("p",null,"Adds a TFA secret to the user account.",-1),et=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-9"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-9"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"secret"),e(),s("strong",null,"Required"),s("br"),e(" The TFA secret from tfa/generate.")]),s("p",null,[s("code",{class:""},"otp"),e(),s("strong",null,"Required"),s("br"),e(" OTP generated with the secret, to recheck if the user has a correct TFA setup")])]),s("h3",{id:"returns-14"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-14"},"#")]),s("div",{class:"definitions"},[s("p",null,"Empty response.")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-14"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-14"},"#")]),s("pre",null,[s("code",{class:""},`POST /users/me/tfa/enable
-`)]),s("h5",{id:"example-24"},[e("Example "),s("a",{class:"header-anchor",href:"#example-24"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/me/tfa/enable"),e(`
-{
-	`),s("span",{class:"hljs-attr"},'"otp"'),e(": "),s("span",{class:"hljs-string"},'"123456"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"secret"'),e(": "),s("span",{class:"hljs-string"},'"3CtiutsNBmY3szHE"'),e(`
-}
-`)])]),s("h3",{id:"graphql-14"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-14"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	users_me_tfa_enable(otp:`),s("span",{class:"hljs-type"}," String"),e("!, secret:"),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
-}
-`)])]),s("h5",{id:"example-25"},[e("Example "),s("a",{class:"header-anchor",href:"#example-25"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	users_me_tfa_enable(otp: `),s("span",{class:"hljs-string"},'"123456"'),e(", secret: "),s("span",{class:"hljs-string"},'"3CtiutsNBmY3szHE"'),e(`)
-}
-`)])])])],-1),at=s("hr",null,null,-1),tt=s("h2",{id:"disable-two-factor-authentication"},[e("Disable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#disable-two-factor-authentication"},"#")],-1),lt=s("p",null,"Disables two-factor authentication by removing the OTP secret from the user.",-1),rt=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-10"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-10"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"otp"),e(),s("strong",null,"Required"),s("br"),e(" One-time password generated by the authenticator app.")])]),s("h3",{id:"returns-15"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-15"},"#")]),s("p",null,"Empty response.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-15"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-15"},"#")]),s("pre",null,[s("code",{class:""},`POST /users/me/tfa/disable
-`)]),s("h5",{id:"example-26"},[e("Example "),s("a",{class:"header-anchor",href:"#example-26"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/me/tfa/disable"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"otp"'),e(": "),s("span",{class:"hljs-string"},'"859014"'),e(`
-}
-`)])]),s("h3",{id:"graphql-15"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-15"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	users_me_tfa_disable(otp:`),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
-}
-`)])]),s("h5",{id:"example-27"},[e("Example "),s("a",{class:"header-anchor",href:"#example-27"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	users_me_tfa_disable(otp: `),s("span",{class:"hljs-string"},'"591763"'),e(`)
-}
-`)])])])],-1),nt={title:"Users",modularExtension:!1,pageClass:"page-reference"},ct={name:"users",setup(ot,{expose:c}){return c({frontmatter:{title:"Users",modularExtension:!1,pageClass:"page-reference"}}),(ht,it)=>{const t=r("router-link"),o=r("docswrapper");return h(),i(o,{frontmatter:nt},{default:a(()=>[s("div",d,[s("div",u,[s("div",p,[s("blockquote",null,[s("p",null,[_,l(t,{to:"/docs/getting-started/glossary/#users/"},{default:a(()=>[g]),_:1}),f])])]),m]),j,y,s("div",b,[s("div",q,[s("div",v,[w,x,T,R,E,S,P,k,A,s("p",null,[U,O,L,C,I,l(t,{to:"/docs/reference/files/"},{default:a(()=>[Q]),_:1}),G]),B,D,M,F,s("p",null,[H,N,V,W,Y,l(t,{to:"/docs/reference/roles"},{default:a(()=>[z]),_:1}),J]),K,X,Z,$,ss,es,as])]),ts]),ls,rs,ns,s("div",cs,[s("div",os,[hs,s("p",null,[is,l(t,{to:"/docs/reference/query"},{default:a(()=>[ds]),_:1}),us]),ps,s("p",null,[_s,l(t,{to:"/docs/reference/query/#limit"},{default:a(()=>[gs]),_:1}),fs,ms,js])]),s("div",ys,[bs,qs,s("p",null,[l(t,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[vs]),_:1})]),ws,xs,Ts,Rs,Es])]),Ss,Ps,ks,s("div",As,[s("div",Us,[Os,s("p",null,[Ls,l(t,{to:"/docs/reference/query"},{default:a(()=>[Cs]),_:1}),Is]),Qs,Gs]),Bs]),Ds,Ms,Fs,s("div",Hs,[s("div",Ns,[Vs,s("p",null,[Ws,l(t,{to:"/docs/reference/query"},{default:a(()=>[Ys]),_:1}),zs]),Js,Ks]),Xs]),Zs,$s,se,s("div",ee,[s("div",ae,[te,s("p",null,[le,l(t,{to:"/docs/reference/query"},{default:a(()=>[re]),_:1}),ne]),ce,oe]),he]),ie,de,ue,s("div",pe,[s("div",_e,[ge,s("p",null,[fe,l(t,{to:"/docs/reference/query"},{default:a(()=>[me]),_:1}),je]),ye,be,qe,ve,we]),xe]),Te,Re,Ee,s("div",Se,[s("div",Pe,[ke,s("p",null,[Ae,l(t,{to:"/docs/reference/query"},{default:a(()=>[Ue]),_:1}),Oe]),Le,Ce,Ie,Qe,Ge]),Be]),De,Me,Fe,s("div",He,[s("div",Ne,[Ve,s("p",null,[We,l(t,{to:"/docs/reference/query"},{default:a(()=>[Ye]),_:1}),ze]),Je,Ke,Xe,Ze]),$e]),sa,ea,aa,s("div",ta,[s("div",la,[ra,s("p",null,[na,l(t,{to:"/docs/reference/query"},{default:a(()=>[ca]),_:1}),oa]),ha,ia,da,ua]),pa]),_a,ga,fa,ma,ja,ya,ba,qa,va,wa,xa,s("div",Ta,[s("div",Ra,[Ea,s("div",Sa,[Pa,ka,s("p",null,[Aa,Ua,Oa,La,Ca,Ia,l(t,{to:"/docs/configuration/config-options/#security"},{default:a(()=>[Qa,Ga]),_:1}),Ba])]),Da,Ma]),Fa]),Ha,Na,Va,Wa,Ya,za,Ja,Ka,Xa,Za,$a,st,et,at,tt,lt,rt])]),_:1})}}};typeof n=="function"&&n(ct);export{ct as default,nt as frontmatter};

package/dist/assets/webhooks.61b11e7d.js

@@ -1 +0,0 @@
-import{a as i,o as s,b as r,w as a,g as e,B as o}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const h=e("div",{class:"markdown-body"},[e("blockquote",null,[e("p",null,[o("Webhooks are configured within the App (no code required) and send HTTP requests when a specific event is triggered. "),e("a",{href:"https://en.wikipedia.org/wiki/Webhook",target:"_blank",rel:"noopener noreferrer"},"Learn more about Webhooks"),o(".")])]),e("h2",{id:"creating-webhooks"},[o("Creating Webhooks "),e("a",{class:"header-anchor",href:"#creating-webhooks"},"#")]),e("ol",null,[e("li",null,[o("Navigate to "),e("strong",null,[o("Settings "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),o(" Webhooks")])]),e("li",null,[o("Click "),e("span",{mi:"",btn:""},"add"),o(" in the header")]),e("li",null,[o("Complete the "),e("strong",null,"other webhook form fields"),o(" outlined below")])]),e("ul",null,[e("li",null,[e("strong",null,"Name"),o(" \u2014 A name to help remember this webhooks purpose")]),e("li",null,[e("strong",null,"Method"),o(" \u2014 Send as either a HTTP "),e("code",{class:""},"GET"),o(" or "),e("code",{class:""},"POST"),o(" request")]),e("li",null,[e("strong",null,"URL"),o(" \u2014 The URL to send the request to")]),e("li",null,[e("strong",null,"Status"),o(" \u2014 Whether the webhook is active (enabled) or inactive (disabled)")]),e("li",null,[e("strong",null,"Data"),o(" \u2014 Whether the event\u2019s data should be sent along with the request")]),e("li",null,[e("strong",null,"Request Headers"),o(" \u2014 Custom headers that will be added to the webhook request")]),e("li",null,[e("strong",null,"Trigger Actions"),o(" \u2014 The specific actions that will trigger the event")]),e("li",null,[e("strong",null,"Trigger Collections"),o(" \u2014 The specific collections for which the above actions will trigger events")])]),e("h2",{id:"disabling-webhooks"},[o("Disabling Webhooks "),e("a",{class:"header-anchor",href:"#disabling-webhooks"},"#")]),e("ol",null,[e("li",null,[o("Navigate to "),e("strong",null,[o("Settings "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),o(" Webhooks "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),o(" [Webhook]")])]),e("li",null,[o("Set the "),e("strong",null,"status field to inactive")])]),e("h2",{id:"deleting-webhooks"},[o("Deleting Webhooks "),e("a",{class:"header-anchor",href:"#deleting-webhooks"},"#")]),e("ol",null,[e("li",null,[o("Navigate to "),e("strong",null,[o("Settings "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),o(" Webhooks "),e("span",{mi:"",icon:"",dark:""},"chevron_right"),o(" [Webhook]")])]),e("li",null,[o("Click "),e("span",{mi:"",btn:"",dngr:""},"delete"),o(" in the header")]),e("li",null,[o("Confirm this decision by clicking "),e("strong",null,"Delete"),o(" in the dialog")])]),e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"This action is permanent and can not be undone. Please proceed with caution.")])],-1),c={title:"Webhooks",modularExtension:!1},d={name:"webhooks",setup(u,{expose:t}){return t({frontmatter:{title:"Webhooks",modularExtension:!1}}),(g,b)=>{const l=i("docswrapper");return s(),r(l,{frontmatter:c},{default:a(()=>[h]),_:1})}}};typeof n=="function"&&n(d);export{d as default,c as frontmatter};