@directus/app 9.13.0 → 9.14.0

package/dist/assets/users.c27bf116.js

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

package/dist/assets/utilities.5c027346.js

@@ -1,74 +0,0 @@
-import{a as r,o as i,b as c,w as a,g as e,e as l,B as s}from"./runtime-core.esm-bundler.e6808e6c.js";const d={class:"markdown-body"},u=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Utilities are the various helper endpoints located within the API.")])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#generate-a-hash"},"Generate a Hash")]),e("li",null,[e("a",{href:"#verify-a-hash"},"Verify a Hash")]),e("li",null,[e("a",{href:"#manually-sort-items-in-collection"},"Manually Sort Items in Collection")]),e("li",null,[e("a",{href:"#import-data-from-file"},"Import Data from File")]),e("li",null,[e("a",{href:"#export-data-to-a-file"},"Export Data to a File")]),e("li",null,[e("a",{href:"#clear-the-internal-cache"},"Clear the Internal Cache")])])])])])],-1),p=e("hr",null,null,-1),_=e("h2",{id:"generate-a-hash"},[s("Generate a Hash "),e("a",{class:"header-anchor",href:"#generate-a-hash"},"#")],-1),f=e("p",null,"Generate a hash for a given string.",-1),m=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"string"),s(),e("strong",null,"Required"),e("br"),s(" String to hash.")])]),e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")]),e("p",null,"Hashed string.")]),e("div",{class:"right"},[e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")]),e("pre",null,[e("code",null,`POST /utils/hash/generate
-`)]),e("h5",{id:"example"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /utils/hash/generate"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"string"'),s(": "),e("span",{class:"hljs-string"},'"Hello World!"'),s(`
-}
-`)])]),e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	utils_hash_generate(string:`),e("span",{class:"hljs-type"}," String"),s("!):"),e("span",{class:"hljs-type"}," String"),s(`
-}
-`)])]),e("h5",{id:"example-2"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	utils_hash_generate(string: `),e("span",{class:"hljs-string"},'"Hello World!"'),s(`)
-}
-`)])])])],-1),g=e("hr",null,null,-1),y=e("h2",{id:"verify-a-hash"},[s("Verify a Hash "),e("a",{class:"header-anchor",href:"#verify-a-hash"},"#")],-1),q=e("p",null,"Verify a string with a hash.",-1),j=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"string"),s(),e("strong",null,"Required"),e("br"),s(" Source string.")]),e("p",null,[e("code",null,"hash"),s(),e("strong",null,"Required"),e("br"),s(" Hash you want to verify against.")])]),e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")]),e("p",null,"Boolean.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`POST /utils/hash/verify
-`)]),e("h5",{id:"example-3"},[s("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /utils/hash/verify"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"string"'),s(": "),e("span",{class:"hljs-string"},'"Hello World!"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"hash"'),s(": "),e("span",{class:"hljs-string"},'"$arg...fEfM"'),s(`
-}
-`)])]),e("h3",{id:"graphql-2"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	utils_hash_verify(hash:`),e("span",{class:"hljs-type"}," String"),s("!, string:"),e("span",{class:"hljs-type"}," String"),s("!):"),e("span",{class:"hljs-type"}," Boolean"),s(`
-}
-`)])])])],-1),b=e("hr",null,null,-1),v=e("h2",{id:"manually-sort-items-in-collection"},[s("Manually Sort Items in Collection "),e("a",{class:"header-anchor",href:"#manually-sort-items-in-collection"},"#")],-1),x=e("p",null,"If a collection has a sort field, this util can be used to move items in that manual order.",-1),A=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-3"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"item"),s(),e("strong",null,"Required"),e("br"),s(" Primary key of the item you\u2019re moving in the collection.")]),e("p",null,[e("code",null,"to"),s(),e("strong",null,"Required"),e("br"),s(" Primary key of the item you\u2019re moving the source item too.")])]),e("h3",{id:"returns-3"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /utils/sort/:collection
-`)]),e("h5",{id:"example-4"},[s("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /utils/sort/articles"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"item"'),s(": "),e("span",{class:"hljs-number"},"16"),s(`,
-	`),e("span",{class:"hljs-attr"},'"to"'),s(": "),e("span",{class:"hljs-number"},"51"),s(`
-}
-`)])]),e("h3",{id:"graphql-3"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	utils_sort(collection:`),e("span",{class:"hljs-type"}," String"),s("!, item:"),e("span",{class:"hljs-literal"}," ID"),s("!, to:"),e("span",{class:"hljs-literal"}," ID"),s("!):"),e("span",{class:"hljs-type"}," Boolean"),s(`
-}
-`)])]),e("h5",{id:"example-5"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	utils_sort(collection: `),e("span",{class:"hljs-string"},'"articles"'),s(", item: "),e("span",{class:"hljs-number"},"16"),s(", to: "),e("span",{class:"hljs-number"},"51"),s(`)
-}
-`)])])])],-1),S=e("hr",null,null,-1),E=e("h2",{id:"import-data-from-file"},[s("Import Data from File "),e("a",{class:"header-anchor",href:"#import-data-from-file"},"#")],-1),R=s("Import multiple records from a JSON or CSV file into a collection. Relies on a "),T=e("code",null,"multipart/form-data",-1),w=s(" encoded request, just like regular file uploads. Check "),P=s("Upload a File"),C=s(" for more information."),O=s("The import endpoint expects the file structure to match "),F=s("the export query parameter"),k=s(". For JSON, this is an array of objects, where every object is an item. For CSV, the first line has to be the columns header."),I={class:"two-up"},B={class:"left"},D=e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),M=s("Send the file in a "),G=e("code",null,"multipart/form-data",-1),H=s(" request. See "),L=s("Upload a File"),U=s(" for more information."),V=e("h3",{id:"returns-4"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),N=e("p",null,"Empty body.",-1),Q=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`POST /utils/import/:collection
-`)]),e("h5",{id:"example-6"},[s("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",null,`POST /utils/import/articles
-
-Content-Type: multipart/form-data; charset=utf-8; boundary=__X_BOUNDARY__
-Content-Length: 3442422
-
---__X_BOUNDARY__
-Content-Disposition: form-data; name="file"; filename="articles.csv"
-Content-Type: text/csv
-
-"id","title","another","created_by"
-1,"My First Articled","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
-2,"My Second Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
-3,"My Updated Third Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
-4,"My Fourth Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
-5,"My Fifth Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
-...
-`)]),e("h3",{id:"graphql-4"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("p",null,"n/a")],-1),W=e("hr",null,null,-1),J=e("h2",{id:"export-data-to-a-file"},[s("Export Data to a File "),e("a",{class:"header-anchor",href:"#export-data-to-a-file"},"#")],-1),X=e("p",null,"Export a larger data set to a file in the File Library",-1),Y={class:"two-up"},$={class:"left"},z=e("h3",{id:"query-parameters"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),K=e("p",null,"Doesn\u2019t use any query parameters.",-1),Z=e("h3",{id:"request-body-5"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-5"},"#")],-1),ee={class:"definitions"},se=e("p",null,[e("code",null,"format"),s(),e("strong",null,"Required"),e("br"),s(" What file format to save the export to. One of "),e("code",null,"csv"),s(", "),e("code",null,"xml"),s(", "),e("code",null,"json"),s(".")],-1),ae=e("code",null,"query",-1),te=s(),le=e("strong",null,"Required",-1),ne=e("br",null,null,-1),re=s(" The query object to use for the export. Supports the "),oe=s("global query parameters"),he=s("."),ie=e("p",null,[e("code",null,"file"),s(),e("strong",null,"File Object"),e("br"),s(" Partial file object to tweak where / how the export file is saved.")],-1),ce=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),de=e("p",null,"Empty body",-1),ue=e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`POST /utils/export/:collection
-`)]),e("h5",{id:"example-7"},[s("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",null,`POST /utils/export/articles
-`)]),e("pre",null,[e("code",{class:"language-json"},[s(`{
-	`),e("span",{class:"hljs-attr"},'"query"'),s(`: {
-		`),e("span",{class:"hljs-attr"},'"filter"'),s(`: {
-			`),e("span",{class:"hljs-attr"},'"status"'),s(`: {
-				`),e("span",{class:"hljs-attr"},'"_eq"'),s(": "),e("span",{class:"hljs-string"},'"published"'),s(`
-			}
-		}
-	},
-	`),e("span",{class:"hljs-attr"},'"file"'),s(`: {
-		`),e("span",{class:"hljs-attr"},'"folder"'),s(": "),e("span",{class:"hljs-string"},'"34e95c19-cc50-42f2-83c8-b97616ac2390"'),s(`
-	}
-}
-`)])]),e("h3",{id:"graphql-5"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("p",null,"n/a")],-1),pe=e("hr",null,null,-1),_e=e("h2",{id:"clear-the-internal-cache"},[s("Clear the Internal Cache "),e("a",{class:"header-anchor",href:"#clear-the-internal-cache"},"#")],-1),fe=e("p",null,"Resets both the data and schema cache of Directus. This endpoint is only available to admin users.",-1),me=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-6"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-6"},"#")]),e("p",null,"n/a"),e("h3",{id:"returns-6"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")]),e("p",null,"Empty body")]),e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`POST /utils/cache/clear
-`)]),e("h3",{id:"graphql-6"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	utils_cache_clear
-}
-`)])])])],-1),be="Utilities",ve=!1,xe="page-reference",Ae={name:"utilities",setup(ge,{expose:o}){const n={title:"Utilities",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:n}),(ye,qe)=>{const t=r("router-link"),h=r("docs-wrapper");return i(),c(h,{frontmatter:n},{default:a(()=>[e("div",d,[u,p,_,f,m,g,y,q,j,b,v,x,A,S,E,e("p",null,[R,T,w,l(t,{to:"/docs/reference/files/#upload-a-file"},{default:a(()=>[P]),_:1}),C]),e("p",null,[O,l(t,{to:"/docs/reference/query/#export"},{default:a(()=>[F]),_:1}),k]),e("div",I,[e("div",B,[D,e("p",null,[M,G,H,l(t,{to:"/docs/reference/files/#upload-a-file"},{default:a(()=>[L]),_:1}),U]),V,N]),Q]),W,J,X,e("div",Y,[e("div",$,[z,K,Z,e("div",ee,[se,e("p",null,[ae,te,le,ne,re,l(t,{to:"/docs/reference/query"},{default:a(()=>[oe]),_:1}),he]),ie]),ce,de]),ue]),pe,_e,fe,me])]),_:1})}}};export{Ae as default,ve as modularExtension,xe as pageClass,be as title};