@directus/app 9.14.5 → 9.15.0

package/dist/assets/{users.9e656e05.js → users.0638ab5f.js}

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