@directus/app 9.22.3 → 9.23.3

package/dist/assets/users-039eb6fe.js

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

package/dist/assets/users-475ad639.js

@@ -1 +0,0 @@
-import{a as i,o as c,e as d,y as o,u as e,q as s,z as l}from"./runtime-core.esm-bundler-753bcc58.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,[s("Users represent the distinct people "),e("em",null,"(and entities)"),s(" that interact with your project. Each user can be assigned a role, which defines a user’s access permissions.")])],-1),p={class:"tip hint"},m=e("div",{class:"hint-title"},"Learn More",-1),_=e("strong",null,"Settings > Roles & Permissions > [Role]",-1),g=e("h2",{id:"invite-a-user",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#invite-a-user"},"#"),s(" Invite a User")],-1),v=e("video",{title:"Invite a User",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/users-20220909/invite-a-user-20220907A.mp4",type:"video/mp4"})],-1),f=e("p",null,"To invite people to become users via email and automatically assign them a role in the process, follow these steps.",-1),w=e("ol",null,[e("li",null,[s("Navigate to "),e("strong",null,"Settings > Roles & Permissions > [Role]"),s(".")]),e("li",null,[s("Click "),e("span",{mi:"",btn:"",muted:""},"person_add"),s(" in the page header.")]),e("li",null,"Enter one or more email addresses, separated by a comma and a space."),e("li",null,[s("Click "),e("strong",null,"Invite"),s(" to confirm.")])],-1),y=e("div",{class:"tip hint"},[e("p",null,"Instead of comma-separated emails, you can also add new emails line-by-line.")],-1),U=e("h2",{id:"create-a-user",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-user"},"#"),s(" Create a User")],-1),b=e("video",{title:"Create a User",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/users-20220909/create-new-user-20220907A.mp4",type:"video/mp4"})],-1),k=e("p",null,[s("To create a user and assign their role "),e("em",null,"(and other details)"),s(" follow these steps.")],-1),x=e("ol",null,[e("li",null,[s("Navigate to "),e("strong",null,"Settings > Roles & Permissions > [Role]"),s(".")]),e("li",null,[s("Under the "),e("strong",null,"Users in Role"),s(" section, click "),e("strong",null,"Create New"),s(" and a drawer will open.")]),e("li",null,[s("Fill in the user’s details as desired. The newly created user will now be visible under "),e("strong",null,"Users in Role"),s(".")]),e("li",null,[s("Click "),e("span",{mi:"",btn:""},"check"),s(" in the page header to confirm and the drawer will close.")])],-1),R=e("h2",{id:"assign-role-to-existing-user",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#assign-role-to-existing-user"},"#"),s(" Assign Role to Existing User")],-1),C=e("video",{title:"Add an Existing User",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/users-20220909/assign-to-existing-role-20220909A.mp4",type:"video/mp4"})],-1),T=e("p",null,"To assign a role to an existing user, follow these steps.",-1),E=e("ol",null,[e("li",null,[s("Navigate to "),e("strong",null,"Settings > Roles & Permissions > [Role]"),s(".")]),e("li",null,[s("Under the "),e("strong",null,"Users in Role"),s(" section, click "),e("strong",null,"Add Existing"),s(" and a drawer will open.")]),e("li",null,"Select users as desired."),e("li",null,[s("Click "),e("span",{mi:"",btn:""},"check"),s(" to confirm and the drawer will close. The added user(s) will now be visible under "),e("strong",null,"Users in Role"),s(".")]),e("li",null,[s("Click "),e("span",{mi:"",btn:""},"check"),s(" in the page header to confirm.")])],-1),A=e("h2",{id:"remove-user%E2%80%99s-role",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#remove-user%E2%80%99s-role"},"#"),s(" Remove User’s Role")],-1),N=e("video",{title:"Remove User from Role",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/users-20220909/remove-user-role-20220908A.mp4",type:"video/mp4"})],-1),S=e("p",null,"To remove a user from a role, follow these steps.",-1),I=e("ol",null,[e("li",null,[s("Under the "),e("strong",null,"Users in Role"),s(" section, click "),e("span",{mi:"",icon:"",dngr:""},"close"),s(" and the user will be removed from the role.")]),e("li",null,[s("Click "),e("span",{mi:"",btn:""},"check"),s(" in the page header to confirm.")])],-1),P=e("p",null,[s("The user(s) now have a "),e("code",null,"NULL"),s(" role, public permissions, until "),e("a",{href:"#assign-role-to-existing-user"},"assigned a new role"),s(".")],-1),q="Users",D=!1,z="Users represent the distinct people and entities that interact with your project.",F=null,H={__name:"users",setup(j,{expose:r}){const t={title:"Users",modularExtension:!1,description:"Users represent the distinct people and entities that interact with your project.",readTime:null};return r({frontmatter:t}),(B,L)=>{const n=i("router-link"),a=i("docs-wrapper");return c(),d(a,{frontmatter:t},{default:o(()=>[e("div",u,[h,e("div",p,[m,e("p",null,[s("To configure users programmatically, see our API documentation on "),l(n,{to:"/docs/reference/system/users.md"},{default:o(()=>[s("users")]),_:1}),s(".")])]),e("p",null,[s("Within the Data Studio, the "),l(n,{to:"/docs/app/user-directory.md"},{default:o(()=>[s("User Directory")]),_:1}),s(" is the primary place to manage users. However, certain controls are included in "),_,s(" as well, which is what the following sections will focus on.")]),g,v,f,w,y,U,b,k,x,R,C,T,E,A,N,S,I,P])]),_:1})}}};export{H as default,z as description,D as modularExtension,F as readTime,q as title};

package/dist/assets/users-roles-permissions-c0aaea95.js

@@ -1 +0,0 @@
-import{a as n,o as d,e as u,y as o,u as e,q as s,z as i}from"./runtime-core.esm-bundler-753bcc58.js";const c={class:"markdown-body"},h=e("em",null,"who can access what",-1),m=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/users-roles-permissions-20220909/users-roles-permissions-20220907A.webp",alt:"Users, Roles and Permissions"})],-1),p={class:"tip hint"},f=e("div",{class:"hint-title"},"Before You Begin",-1),_={class:"tip hint"},g=e("div",{class:"hint-title"},"Learn More",-1),w=e("p",null,[s("In order to understand how users, roles, and permissions work in Directus, a conceptual understanding of "),e("em",null,"how they work in general"),s(" will be helpful. The following few paragraphs will introduce you to how users, roles, and permissions work within a relational database. If you’re already familiar with these concepts, feel free to skip to "),e("a",{href:"#how-it-works-in-directus"},"How it Works in Directus"),s(".")],-1),y=e("h3",{id:"users",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#users"},"#"),s(" Users")],-1),b=e("code",null,"users",-1),v=e("em",null,"users",-1),k=e("em",null,"“data”",-1),x=e("p",null,[s("Projects typically have many different kinds of users. For example, you’ll need developers and administrators to design the data model as well as manage all its data. Your team may have other users, such as data analysts, content writers, or managers who need to access to some sensitive data, but not the entire data model. Finally, you might have end-users, such as customers, subscribers, 3rd party sellers, "),e("em",null,"and beyond"),s(" who need access to their own personal data, but should not be able to access any other business data. Therefore, we need to be able to create permissions to define what a user can and can’t access.")],-1),D=e("div",{class:"tip hint"},[e("p",null,[s("Another key point is that a user "),e("em",null,"does not need to be a person at all"),s(". A user could be an AI bot, chat bot, API, or any other entity that can login and interact with the database.")])],-1),R=e("h3",{id:"roles",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#roles"},"#"),s(" Roles")],-1),T=e("em",null,"(managers, writers, subscribers, etc)",-1),U=e("p",null,[s("Regardless of your project, your SQL database will "),e("em",null,"always"),s(" need an administrator role and a public role. In addition, you may need any number of custom roles.")],-1),A=e("p",null,[e("strong",null,"Administrators"),e("br"),s(" An administrator role provides complete, unrestricted control over the database, including the data model and all it data. This cannot be limited, as by definition it would no longer be an administrator role. You need at least one user in an administrator role. Otherwise, it would be impossible to fully manage the database.")],-1),I=e("p",null,[e("strong",null,"Public"),e("br"),s(" A public role defines access permissions for unauthenticated requests to the database. That means that if you enable an access permission for this role, "),e("em",null,"everybody has that permission enabled"),s(". Remember, the database has no idea which data you’d want the public to see. So to be safe, all permissions begin turned off by default. It is up to the administrators to re-configure these and define exactly what the public role has access to.")],-1),P=e("p",null,[e("strong",null,"Custom Roles"),e("br"),s(" In addition to these two extreme types of roles, you may need to create more roles each with their own unique set of permissions. The roles you create and the permissions you configure for them are completely open-ended and dependent on your project’s needs.")],-1),j=e("h3",{id:"permissions",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#permissions"},"#"),s(" Permissions")],-1),S=e("p",null,[s("Remember, for the majority of projects, it wouldn’t be safe or ethical to give every user full access to the data. Users could accidentally damage data or even take malicious actions against the project and its users. For example, a student may need to be able to "),e("em",null,"see their grade, but not be able to change it"),s(".")],-1),C=e("p",null,[s("Thus, there are four types of permissions for each data table, based on the four CRUD actions you can do to data in a database: "),e("em",null,"create, read, update, and delete"),s("… Hence you often hear the term CRUD permissions. You can configure CRUD permissions on each data table as desired. For example, you can grant:")],-1),W=e("ul",null,[e("li",null,"read-only permission"),e("li",null,"read and write but not update or delete permissions"),e("li",null,[e("em",null,"any other combination of the four")])],-1),B=e("h3",{id:"business-rules",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#business-rules"},"#"),s(" Business Rules")],-1),Y=e("p",null,"In many cases, you will need to grant permissions to data based on its value, or by some other conditional logic. This type of conditional permission is often called a business rule.",-1),F=e("p",null,[s("To give an example, students should be able to read to their own grades, but not the grades of other students. So you could create a business rule for the "),e("code",null,"student"),s(" role, so that a user can only see his or her own grade.")],-1),q=e("p",null,"Taking this example one step further, we’d also want to allow students to read and create answers to an online test, but not update or delete their test answers once submitted. Then you may need a business rule to crate a submission deadline. Finally, you likely want to restrict each student’s CRUD access to all other student tests.",-1),E=e("p",null,"It is common to have multiple, complex business rules in a project.",-1),H=e("h2",{id:"how-it-works-in-directus",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works-in-directus"},"#"),s(" How it Works in Directus")],-1),L=e("video",{title:"How Users, Roles, & Permissions Work",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/users-roles-permissions-20220909/how-users-roles-and-permissions-work-20220909A.mp4",type:"video/mp4"})],-1),N=e("p",null,"While you have full reign to configure these using SQL, Directus also provides a complete system to configure and manage users, roles, and permissions without writing a single line of SQL. The process has three key steps.",-1),Q=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"No Artificial Limits"),e("p",null,"You can create as many roles as you need, (re)assign them to as many users as many times you please, and configure complex granular permissions as desired.")],-1),V=e("div",{class:"tip hint"},[e("p",null,"Remember, the following users, role and permissions systems built into Directus cannot be deleted, however using them is optional. You may configure your own system as desired.")],-1),z=e("h2",{id:"directus-users",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#directus-users"},"#"),s(" Directus Users")],-1),G=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/users-roles-permissions-20220909/users-20220807A.webp",alt:"Users in the Directus Data Studio"})],-1),M=e("strong",null,"Settings > Roles and Permissions",-1),O=e("h2",{id:"directus-roles",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#directus-roles"},"#"),s(" Directus Roles")],-1),J=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/users-roles-permissions-20220909/roles-20220907A.webp",alt:"Roles in the Directus Data Studio"})],-1),K=e("p",null,"You can create as many roles as you need for your project. Directus also comes with built-in administrator and public roles, which cannot be deleted.",-1),X=e("p",null,"The administrator role provides full permissions for all data in the app, and this cannot be limited. You must always have at least one user with an administrator role.",-1),Z=e("p",null,[s("The public role comes with all access permissions turned off by default, but this can be reconfigured as desired. Remember, any access permissions granted to this role will apply to everyone, including unauthenticated web traffic "),e("em",null,"and all existing users"),s(". If you wish to keep the project private, simply keep all permissions turned off.")],-1),$=e("h2",{id:"directus-permissions",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#directus-permissions"},"#"),s(" Directus Permissions")],-1),ee=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/users-roles-permissions-20220909/permissions-20220907A.webp",alt:"Roles in the Directus Data Studio"})],-1),se=e("p",null,[s("Directus offers an extremely granular, yet easy to configure permissions system. When you "),e("a",{href:"#create-a-role"},"create a role"),s(", all permissions are turned off by default, allowing you to explicitly grant permissions as desired.")],-1),oe=e("a",{href:"#business-rules"},"business rules",-1),te=e("em",null,"create, read, update, delete, and share",-1),ie=e("em",null,"fifth",-1),re=e("h2",{id:"workflows",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#workflows"},"#"),s(" Workflows")],-1),ne=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/workflows-20220909/workflows-20220909B.webp",alt:"Workflows in the Directus"})],-1),ce="Users, Roles & Permissions",he=!1,me="Users are the individual accounts for authenticating into the API and App. Each user belongs to a Role which defines its access Permissions.",pe="7 min read",fe={__name:"users-roles-permissions",setup(ae,{expose:a}){const r={title:"Users, Roles & Permissions",modularExtension:!1,description:"Users are the individual accounts for authenticating into the API and App. Each user belongs to a Role which defines its access Permissions.",readTime:"7 min read"};return a({frontmatter:r}),(le,de)=>{const t=n("router-link"),l=n("docs-wrapper");return d(),u(l,{frontmatter:r},{default:o(()=>[e("div",c,[e("blockquote",null,[e("p",null,[s("Users, roles, and permissions work together to determine "),h,s(" inside your database. "),i(t,{to:"/docs/getting-started/glossary#users"},{default:o(()=>[s("Users")]),_:1}),s(" are the individual accounts for authenticating into the project. Each user is assigned a "),i(t,{to:"/docs/getting-started/glossary#roles"},{default:o(()=>[s("role")]),_:1}),s(" which defines its "),i(t,{to:"/docs/getting-started/glossary#permissions"},{default:o(()=>[s("access permissions")]),_:1}),s(".")])]),m,e("div",p,[f,e("p",null,[s("We recommend you try the "),i(t,{to:"/docs/getting-started/quickstart.md"},{default:o(()=>[s("Quickstart Guide")]),_:1}),s(" to get an overview of the platform.")])]),e("div",_,[g,e("p",null,[s("To manage users, role and permissions programmatically via the API, please see our API guides on "),i(t,{to:"/docs/reference/system/users.md"},{default:o(()=>[s("users")]),_:1}),s(", "),i(t,{to:"/docs/reference/system/roles.md"},{default:o(()=>[s("roles")]),_:1}),s(", and "),i(t,{to:"/docs/reference/system/permissions.md"},{default:o(()=>[s("permissions")]),_:1}),s(".")])]),w,y,e("p",null,[s("Remember, "),i(t,{to:"/docs/reference/system/users.md"},{default:o(()=>[s("users are data")]),_:1}),s(". They are simply rows in a "),b,s(" data table. It may be easy to forget this if you are new to working with data models, as the term "),v,s(" can create a warm place in our hearts which distinguishes or elevates it above and beyond term "),k,s(". But from the perspective of the data model, that’s not the case. Users are still just data.")]),x,D,R,e("p",null,[s("In many cases, your project will have multiple users doing the same thing "),T,s(". If we assigned permissions directly to the user, we would have to configure the same permissions over and over, which makes it tedious to change configurations for all users doing the same job and also leads to a higher chance of misconfiguration. This problem is an example of "),i(t,{to:"/docs/configuration/data-model.md#avoid-data-duplication"},{default:o(()=>[s("data duplication")]),_:1}),s(". To avoid this, we create roles, configure the role’s permissions once, then assign the role to users as desired.")]),U,A,I,P,j,S,C,W,B,Y,F,q,E,H,L,N,e("ol",null,[e("li",null,[i(t,{to:"/docs/configuration/users-roles-permissions/roles.md#create-a-role"},{default:o(()=>[s("Create a Role")]),_:1})]),e("li",null,[i(t,{to:"/docs/configuration/users-roles-permissions/permissions.md#configure-role-permissions"},{default:o(()=>[s("Configure its Permissions")]),_:1})]),e("li",null,[i(t,{to:"/docs/configuration/users-roles-permissions/roles.md#assign-role-to-user"},{default:o(()=>[s("Assign Role to User")]),_:1})])]),Q,V,z,G,e("p",null,[s("Within the Data Studio, users are managed within the "),i(t,{to:"/docs/app/user-directory.md"},{default:o(()=>[s("User Directory")]),_:1}),s(". However, there are some controls available to assign users to roles in "),M,s(".")]),e("p",null,[s("To learn more, please see our guide on "),i(t,{to:"/docs/configuration/users-roles-permissions/users.md"},{default:o(()=>[s("users")]),_:1}),s(".")]),O,J,K,X,Z,e("p",null,[s("To learn more, see our guide on "),i(t,{to:"/docs/configuration/users-roles-permissions/roles.md"},{default:o(()=>[s("roles")]),_:1}),s(".")]),$,ee,se,e("p",null,[s("There are two other key points to note about Directus. First, the term "),i(t,{to:"/docs/configuration/users-roles-permissions/permissions.md#configure-custom-permissions"},{default:o(()=>[s("custom access permissions")]),_:1}),s(" is used in place of "),oe,s(", however the concept is the same. Second, instead of the standard CRUD permissions, Directus provides CRUDS permissions: "),te,s(". This "),ie,s(" type of permission, share, defines whether a user has permissions to perform "),i(t,{to:"/docs/app/content/shares.md"},{default:o(()=>[s("data sharing")]),_:1}),s(" on items in a collection.")]),e("p",null,[s("To learn more, see our guide on "),i(t,{to:"/docs/configuration/users-roles-permissions/permissions.md"},{default:o(()=>[s("permissions")]),_:1}),s(".")]),re,ne,e("p",null,[s("Workflows are a way to setup structured stages to content authoring and data management. They are created primarily with custom access permissions, but can be enhanced with email notifications, custom "),i(t,{to:"/docs/extensions/interfaces.md"},{default:o(()=>[s("Interfaces")]),_:1}),s(" as well as "),i(t,{to:"/docs/configuration/flows.md"},{default:o(()=>[s("flows")]),_:1}),s(". Directus supports endlessly configurable workflows.")]),e("p",null,[s("To learn more, see our recipe on "),i(t,{to:"/docs/cookbook/permissions/basic-workflows.md"},{default:o(()=>[s("basic workflows")]),_:1}),s(".")])])]),_:1})}}};export{fe as default,me as description,he as modularExtension,pe as readTime,ce as title};

package/dist/assets/utilities-0a4c2e38.js

@@ -1,74 +0,0 @@
-import{a as o,o as h,e as i,y as t,u as s,q as a,z as e}from"./runtime-core.esm-bundler-753bcc58.js";const u={class:"markdown-body"},p=s("blockquote",null,[s("p",null,"Utilities are the various helper endpoints located within the API.")],-1),d=s("hr",null,null,-1),_=s("h2",{id:"generate-a-hash",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#generate-a-hash"},"#"),a(" Generate a Hash")],-1),m=s("p",null,"Generate a hash for a given string.",-1),j=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),a(" Request Body")],-1),f=s("p",null,[s("code",null,"string"),a(),s("strong",null,"Required"),s("br"),a(" String to hash.")],-1),b=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),a(" Returns")],-1),y=s("p",null,"Hashed string.",-1),g=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),a(" REST API")],-1),x=s("pre",null,[s("code",null,`POST /utils/hash/generate
-`)],-1),q=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),a(" Example")],-1),A=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /utils/hash/generate"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"string"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Hello World!"'),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),S=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),a(" GraphQL")],-1),E=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),R=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	utils_hash_generate`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"string"),s("span",{class:"hljs-punctuation"},":"),a(" String"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` String
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),T=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),a(" Example")],-1),P=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	utils_hash_generate`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"string"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Hello World!"'),s("span",{class:"hljs-punctuation"},")"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),k=s("hr",null,null,-1),v=s("h2",{id:"verify-a-hash",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#verify-a-hash"},"#"),a(" Verify a Hash")],-1),w=s("p",null,"Verify a string with a hash.",-1),O=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),a(" Request Body")],-1),C=s("p",null,[s("code",null,"string"),a(),s("strong",null,"Required"),s("br"),a(" Source string.")],-1),F=s("p",null,[s("code",null,"hash"),a(),s("strong",null,"Required"),s("br"),a(" Hash you want to verify against.")],-1),I=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),a(" Returns")],-1),B=s("p",null,"Boolean.",-1),D=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),a(" REST API")],-1),G=s("pre",null,[s("code",null,`POST /utils/hash/verify
-`)],-1),L=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),a(" Example")],-1),M=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /utils/hash/verify"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"string"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Hello World!"'),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"hash"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"$arg...fEfM"'),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),U=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),a(" GraphQL")],-1),Q=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),H=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	utils_hash_verify`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"hash"),s("span",{class:"hljs-punctuation"},":"),a(" String"),s("span",{class:"hljs-punctuation"},"!"),a(", "),s("span",{class:"hljs-symbol"},"string"),s("span",{class:"hljs-punctuation"},":"),a(" String"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` Boolean
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),N=s("hr",null,null,-1),V=s("h2",{id:"manually-sort-items-in-collection",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#manually-sort-items-in-collection"},"#"),a(" Manually Sort Items in Collection")],-1),W=s("p",null,"If a collection has a sort field, this util can be used to move items in that manual order.",-1),J=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),a(" Request Body")],-1),X=s("p",null,[s("code",null,"item"),a(),s("strong",null,"Required"),s("br"),a(" Primary key of the item you’re moving in the collection.")],-1),Y=s("p",null,[s("code",null,"to"),a(),s("strong",null,"Required"),s("br"),a(" Primary key of the item you’re moving the source item too.")],-1),z=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),a(" Returns")],-1),$=s("p",null,"Empty body.",-1),K=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),a(" REST API")],-1),Z=s("pre",null,[s("code",null,`POST /utils/sort/:collection
-`)],-1),ss=s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),a(" Example")],-1),as=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /utils/sort/articles"),a(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"item"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-number"},"16"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"to"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-number"},"51"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),ts=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),a(" GraphQL")],-1),ns=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),es=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	utils_sort`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),a(" String"),s("span",{class:"hljs-punctuation"},"!"),a(", "),s("span",{class:"hljs-symbol"},"item"),s("span",{class:"hljs-punctuation"},":"),a(" ID"),s("span",{class:"hljs-punctuation"},"!"),a(", "),s("span",{class:"hljs-symbol"},"to"),s("span",{class:"hljs-punctuation"},":"),a(" ID"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` Boolean
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),ls=s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),a(" Example")],-1),os=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	utils_sort`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"articles"'),a(", "),s("span",{class:"hljs-symbol"},"item"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-number"},"16"),a(", "),s("span",{class:"hljs-symbol"},"to"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-number"},"51"),s("span",{class:"hljs-punctuation"},")"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),cs=s("hr",null,null,-1),rs=s("h2",{id:"import-data-from-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#import-data-from-file"},"#"),a(" Import Data from File")],-1),hs=s("code",null,"multipart/form-data",-1),is=s("h3",{id:"request-body-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-3"},"#"),a(" Request Body")],-1),us=s("code",null,"multipart/form-data",-1),ps=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),a(" Returns")],-1),ds=s("p",null,"Empty body.",-1),_s=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),a(" REST API")],-1),ms=s("pre",null,[s("code",null,`POST /utils/import/:collection
-`)],-1),js=s("h5",{id:"example-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-5"},"#"),a(" Example")],-1),fs=s("pre",null,[s("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"
-...
-`)],-1),bs=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),a(" GraphQL")],-1),ys=s("p",null,"n/a",-1),gs=s("hr",null,null,-1),xs=s("h2",{id:"export-data-to-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#export-data-to-a-file"},"#"),a(" Export Data to a File")],-1),qs=s("p",null,"Export a larger data set to a file in the File Library",-1),As=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),a(" Query Parameters")],-1),Ss=s("p",null,"Doesn’t use any query parameters.",-1),Es=s("h3",{id:"request-body-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-4"},"#"),a(" Request Body")],-1),Rs=s("p",null,[s("code",null,"format"),a(),s("strong",null,"Required"),s("br"),a(" What file format to save the export to. One of "),s("code",null,"csv"),a(", "),s("code",null,"xml"),a(", "),s("code",null,"json"),a(".")],-1),Ts=s("code",null,"query",-1),Ps=s("strong",null,"Required",-1),ks=s("br",null,null,-1),vs=s("p",null,[s("code",null,"file"),a(),s("strong",null,"File Object"),s("br"),a(" Partial file object to tweak where / how the export file is saved.")],-1),ws=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),a(" Returns")],-1),Os=s("p",null,"Empty body",-1),Cs=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),a(" REST API")],-1),Fs=s("pre",null,[s("code",null,`POST /utils/export/:collection
-`)],-1),Is=s("h5",{id:"example-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-6"},"#"),a(" Example")],-1),Bs=s("pre",null,[s("code",null,`POST /utils/export/articles
-`)],-1),Ds=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),a(`
-	`),s("span",{class:"hljs-attr"},'"query"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"filter"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-			`),s("span",{class:"hljs-attr"},'"status"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-				`),s("span",{class:"hljs-attr"},'"_eq"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"published"'),a(`
-			`),s("span",{class:"hljs-punctuation"},"}"),a(`
-		`),s("span",{class:"hljs-punctuation"},"}"),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),a(`
-	`),s("span",{class:"hljs-attr"},'"file"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-		`),s("span",{class:"hljs-attr"},'"folder"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"34e95c19-cc50-42f2-83c8-b97616ac2390"'),a(`
-	`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),Gs=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),a(" GraphQL")],-1),Ls=s("p",null,"n/a",-1),Ms=s("hr",null,null,-1),Us=s("h2",{id:"clear-the-internal-cache",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#clear-the-internal-cache"},"#"),a(" Clear the Internal Cache")],-1),Qs=s("p",null,"Resets both the data and schema cache of Directus. This endpoint is only available to admin users.",-1),Hs=s("h3",{id:"request-body-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-5"},"#"),a(" Request Body")],-1),Ns=s("p",null,"n/a",-1),Vs=s("h3",{id:"returns-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-5"},"#"),a(" Returns")],-1),Ws=s("p",null,"Empty body",-1),Js=s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),a(" REST API")],-1),Xs=s("pre",null,[s("code",null,`POST /utils/cache/clear
-`)],-1),Ys=s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),a(" GraphQL")],-1),zs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
-	utils_cache_clear
-`),s("span",{class:"hljs-punctuation"},"}"),a(`
-`)])],-1),aa="Utilities",ta=!1,na="REST and GraphQL API documentation on the Utilities collection in Directus.",ea="3 min read",la="page-reference",oa={__name:"utilities",setup($s,{expose:c}){const l={title:"Utilities",modularExtension:!1,description:"REST and GraphQL API documentation on the Utilities collection in Directus.",readTime:"3 min read",pageClass:"page-reference"};return c({frontmatter:l}),(Ks,Zs)=>{const n=o("router-link"),r=o("docs-wrapper");return h(),i(r,{frontmatter:l},{default:t(()=>[s("div",u,[p,d,_,m,j,f,b,y,g,x,q,A,S,E,R,T,P,k,v,w,O,C,F,I,B,D,G,L,M,U,Q,H,N,V,W,J,X,Y,z,$,K,Z,ss,as,ts,ns,es,ls,os,cs,rs,s("p",null,[a("Import multiple records from a JSON or CSV file into a collection. Relies on a "),hs,a(" encoded request, just like regular file uploads. Check "),e(n,{to:"/docs/reference/files#upload-a-file"},{default:t(()=>[a("Upload a File")]),_:1}),a(" for more information.")]),s("p",null,[a("The import endpoint expects the file structure to match "),e(n,{to:"/docs/reference/query#export"},{default:t(()=>[a("the export query parameter")]),_:1}),a(". 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.")]),is,s("p",null,[a("Send the file in a "),us,a(" request. See "),e(n,{to:"/docs/reference/files#upload-a-file"},{default:t(()=>[a("Upload a File")]),_:1}),a(" for more information.")]),ps,ds,_s,ms,js,fs,bs,ys,gs,xs,qs,As,Ss,Es,Rs,s("p",null,[Ts,a(),Ps,ks,a(" The query object to use for the export. Supports the "),e(n,{to:"/docs/reference/query"},{default:t(()=>[a("global query parameters")]),_:1}),a(".")]),vs,ws,Os,Cs,Fs,Is,Bs,Ds,Gs,Ls,Ms,Us,Qs,Hs,Ns,Vs,Ws,Js,Xs,Ys,zs])]),_:1})}}};export{oa as default,na as description,ta as modularExtension,la as pageClass,ea as readTime,aa as title};

package/dist/assets/uz-8a64d58d.js

@@ -1 +0,0 @@
-var a={code:"uz",buttonText:{month:"Oy",week:"Xafta",day:"Kun",list:"Kun tartibi"},allDayText:"Kun bo'yi",moreLinkText(t){return"+ yana "+t},noEventsText:"Ko'rsatish uchun voqealar yo'q"};export{a as default};

package/dist/assets/validation-59e6bf86.js

@@ -1 +0,0 @@
-import{a as e,o as n,e as s,y as r,u as c}from"./runtime-core.esm-bundler-753bcc58.js";const l=c("div",{class:"markdown-body"},null,-1),m="Validation",u=!1,f={__name:"validation",setup(i,{expose:o}){const t={title:"Validation",modularExtension:!1};return o({frontmatter:t}),(d,_)=>{const a=e("docs-wrapper");return n(),s(a,{frontmatter:t},{default:r(()=>[l]),_:1})}}};export{f as default,u as modularExtension,m as title};