@directus/app 9.4.1 → 9.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/af-ZA.8e0f0a18.js +1 -0
- package/dist/assets/{bg-BG.85fd772c.js → bg-BG.323e646f.js} +1 -1
- package/dist/assets/{config-options.e53341a9.js → config-options.eb4166d8.js} +14 -14
- package/dist/assets/index.1f5fd684.js +26 -0
- package/dist/assets/{index.29d6735e.entry.js → index.22c0e154.entry.js} +45 -45
- package/dist/assets/index.2c36cae9.css +1 -0
- package/dist/assets/index.ca954ed3.css +1 -0
- package/dist/assets/{input-rich-text-html.94180d78.js → input-rich-text-html.a709a214.js} +1 -1
- package/dist/assets/installation.97b1184f.js +1 -0
- package/dist/assets/it-IT.b3999351.js +1 -0
- package/dist/assets/pl-PL.853296be.js +1 -0
- package/dist/assets/users.7cef5043.js +252 -0
- package/dist/index.html +2 -2
- package/package.json +6 -6
- package/dist/assets/af-ZA.26b091a9.js +0 -1
- package/dist/assets/index.2f08ad47.js +0 -26
- package/dist/assets/index.56cdd291.css +0 -1
- package/dist/assets/index.c01059b2.css +0 -1
- package/dist/assets/installation.751b61a8.js +0 -1
- package/dist/assets/it-IT.87ffbbaf.js +0 -1
- package/dist/assets/pl-PL.8828f091.js +0 -1
- package/dist/assets/users.56012dcd.js +0 -237
|
@@ -1,237 +0,0 @@
|
|
|
1
|
-
import{r,p as h,q as i,w as a,B as s,t as l,P as e}from"./vendor.275c9c53.js";const d={class:"markdown-body"},u={class:"two-up"},p={class:"left"},_=e("Directus Users are the individual accounts that let you authenticate into the API and App. Each user belongs to a Role which defines its granular Permissions. "),g=e("Learn more about Users"),f=e("."),m=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-user-object"},"The User Object")]),s("li",null,[s("a",{href:"#list-users"},"List Users")]),s("li",null,[s("a",{href:"#retrieve-a-user"},"Retrieve a User")]),s("li",null,[s("a",{href:"#retrieve-the-current-user"},"Retrieve the Current User")]),s("li",null,[s("a",{href:"#create-a-user"},"Create a User")]),s("li",null,[s("a",{href:"#create-multiple-users"},"Create Multiple Users")]),s("li",null,[s("a",{href:"#update-a-user"},"Update a User")]),s("li",null,[s("a",{href:"#update-multiple-users"},"Update Multiple Users")]),s("li",null,[s("a",{href:"#delete-a-user"},"Delete a User")]),s("li",null,[s("a",{href:"#delete-multiple-users"},"Delete Multiple Users")]),s("li",null,[s("a",{href:"#invite-a-new-user"},"Invite a new User")]),s("li",null,[s("a",{href:"#accept-user-invite"},"Accept User Invite")]),s("li",null,[s("a",{href:"#generate-two-factor-authentication-secret"},"Generate Two-Factor Authentication Secret")]),s("li",null,[s("a",{href:"#enable-two-factor-authentication"},"Enable Two-Factor Authentication")]),s("li",null,[s("a",{href:"#disable-two-factor-authentication"},"Disable Two-Factor Authentication")])])])])],-1),j=s("hr",null,null,-1),y=s("h2",{id:"the-user-object"},[e("The User Object "),s("a",{class:"header-anchor",href:"#the-user-object"},"#")],-1),b={class:"two-up"},q={class:"left"},v={class:"definitions"},w=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the user.")],-1),x=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),E=s("p",null,[s("code",null,"email"),e(),s("strong",null,"string"),s("br"),e(" Email address of the user.")],-1),R=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),P=s("p",null,[s("code",null,"title"),e(),s("strong",null,"string"),s("br"),e(" Title of the user.")],-1),k=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),I=s("br",null,null,-1),C=e(" Avatar file. Many-to-one to "),Q=e("files"),D=e("."),G=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),B=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,"email_notifications"),e(),s("strong",null,"boolean"),s("br"),e(" When this is enabled, the user will receive emails for notifications.")],-1),H=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
|
|
2
|
-
`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),e(`,
|
|
3
|
-
`),s("span",{class:"hljs-attr"},'"first_name"'),e(": "),s("span",{class:"hljs-string"},'"Admin"'),e(`,
|
|
4
|
-
`),s("span",{class:"hljs-attr"},'"last_name"'),e(": "),s("span",{class:"hljs-string"},'"User"'),e(`,
|
|
5
|
-
`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"admin@example.com"'),e(`,
|
|
6
|
-
`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"**********"'),e(`,
|
|
7
|
-
`),s("span",{class:"hljs-attr"},'"location"'),e(": "),s("span",{class:"hljs-string"},'"New York City"'),e(`,
|
|
8
|
-
`),s("span",{class:"hljs-attr"},'"title"'),e(": "),s("span",{class:"hljs-string"},'"CTO"'),e(`,
|
|
9
|
-
`),s("span",{class:"hljs-attr"},'"description"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
|
|
10
|
-
`),s("span",{class:"hljs-attr"},'"tags"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
|
|
11
|
-
`),s("span",{class:"hljs-attr"},'"avatar"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
|
|
12
|
-
`),s("span",{class:"hljs-attr"},'"language"'),e(": "),s("span",{class:"hljs-string"},'"en-US"'),e(`,
|
|
13
|
-
`),s("span",{class:"hljs-attr"},'"theme"'),e(": "),s("span",{class:"hljs-string"},'"auto"'),e(`,
|
|
14
|
-
`),s("span",{class:"hljs-attr"},'"tfa_secret"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
|
|
15
|
-
`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
|
|
16
|
-
`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(`,
|
|
17
|
-
`),s("span",{class:"hljs-attr"},'"token"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
|
|
18
|
-
`),s("span",{class:"hljs-attr"},'"last_access"'),e(": "),s("span",{class:"hljs-string"},'"2021-02-05T10:18:13-05:00"'),e(`,
|
|
19
|
-
`),s("span",{class:"hljs-attr"},'"last_page"'),e(": "),s("span",{class:"hljs-string"},'"/settings/roles/653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(`
|
|
20
|
-
}
|
|
21
|
-
`)])])],-1),N=s("hr",null,null,-1),W=s("h2",{id:"list-users"},[e("List Users "),s("a",{class:"header-anchor",href:"#list-users"},"#")],-1),V=s("p",null,"List all users that exist in Directus.",-1),Y={class:"two-up"},z={class:"left"},J=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),K=e("Supports all "),X=e("global query parameters"),Z=e("."),$=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),ss=e("An array of up to "),es=e("limit"),as=e(),ts=s("a",{href:"#the-user-object"},"user objects",-1),ls=e(". If no items are available, data will be an empty array."),ns={class:"right"},rs=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),cs=s("pre",null,[s("code",null,`GET /users
|
|
22
|
-
SEARCH /users
|
|
23
|
-
`)],-1),os=e("Learn more about SEARCH ->"),hs=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),is=s("pre",null,[s("code",null,`POST /graphql/system
|
|
24
|
-
`)],-1),ds=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
|
|
25
|
-
users: [directus_users]
|
|
26
|
-
}
|
|
27
|
-
`)])],-1),us=s("h5",{id:"example"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),ps=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
|
|
28
|
-
users {
|
|
29
|
-
first_name
|
|
30
|
-
last_name
|
|
31
|
-
email
|
|
32
|
-
}
|
|
33
|
-
}
|
|
34
|
-
`)])],-1),_s=s("hr",null,null,-1),gs=s("h2",{id:"retrieve-a-user"},[e("Retrieve a User "),s("a",{class:"header-anchor",href:"#retrieve-a-user"},"#")],-1),fs=s("p",null,"List an existing user by primary key.",-1),ms={class:"two-up"},js={class:"left"},ys=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),bs=e("Supports all "),qs=e("global query parameters"),vs=e("."),ws=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),xs=s("p",null,[e("Returns the requested "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),Ts=s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`GET /users/:id
|
|
35
|
-
`)]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",null,`GET /users/72a1ce24-4748-47de-a05f-ce9af3033727
|
|
36
|
-
`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
37
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
|
|
38
|
-
users_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_users
|
|
39
|
-
}
|
|
40
|
-
`)])]),s("h5",{id:"example-3"},[e("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
|
|
41
|
-
users_by_id(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(`) {
|
|
42
|
-
first_name
|
|
43
|
-
last_name
|
|
44
|
-
email
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
`)])])],-1),Es=s("hr",null,null,-1),Rs=s("h2",{id:"retrieve-the-current-user"},[e("Retrieve the Current User "),s("a",{class:"header-anchor",href:"#retrieve-the-current-user"},"#")],-1),Ss=s("p",null,"Retrieve the currently authenticated user.",-1),Ps={class:"two-up"},ks={class:"left"},As=s("h3",{id:"query-parameters-3"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Us=e("Supports all "),Os=e("global query parameters"),Ls=e("."),Is=s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Cs=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the currently authenticated user.")],-1),Qs=s("div",{class:"right"},[s("h3",{id:"rest-api-3"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`GET /users/me
|
|
48
|
-
`)]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
49
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
|
|
50
|
-
users_me: directus_users
|
|
51
|
-
}
|
|
52
|
-
`)])]),s("h5",{id:"example-4"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
|
|
53
|
-
users_me {
|
|
54
|
-
email
|
|
55
|
-
}
|
|
56
|
-
}
|
|
57
|
-
`)])])],-1),Ds=s("hr",null,null,-1),Gs=s("h2",{id:"create-a-user"},[e("Create a User "),s("a",{class:"header-anchor",href:"#create-a-user"},"#")],-1),Bs=s("p",null,"Create a new user",-1),Ms={class:"two-up"},Fs={class:"left"},Hs=s("h3",{id:"query-parameters-4"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Ns=e("Supports all "),Ws=e("global query parameters"),Vs=e("."),Ys=s("h3",{id:"request-body"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),zs=s("p",null,[e("A partial "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),Js=s("p",null,[s("code",null,"email"),e(" and "),s("code",null,"password"),e(" are required.")],-1),Ks=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),Xs=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the created user.")],-1),Zs=s("div",{class:"right"},[s("h3",{id:"rest-api-4"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`POST /users
|
|
58
|
-
`)]),s("h5",{id:"example-5"},[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(`
|
|
59
|
-
|
|
60
|
-
{
|
|
61
|
-
`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"another@example.com"'),e(`,
|
|
62
|
-
`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`,
|
|
63
|
-
`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
|
|
64
|
-
}
|
|
65
|
-
`)])]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
66
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
|
|
67
|
-
create_users_item(data: create_directus_users_input!): directus_users
|
|
68
|
-
}
|
|
69
|
-
`)])]),s("h5",{id:"example-6"},[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(` {
|
|
70
|
-
create_users_item(
|
|
71
|
-
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(` }
|
|
72
|
-
) {
|
|
73
|
-
email
|
|
74
|
-
role
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
`)])])],-1),$s=s("hr",null,null,-1),se=s("h2",{id:"create-multiple-users"},[e("Create Multiple Users "),s("a",{class:"header-anchor",href:"#create-multiple-users"},"#")],-1),ee=s("p",null,"Create multiple new users",-1),ae={class:"two-up"},te={class:"left"},le=s("h3",{id:"query-parameters-5"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),ne=e("Supports all "),re=e("global query parameters"),ce=e("."),oe=s("h3",{id:"request-body-2"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),he=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),de=s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),ue=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user objects"),e(" for the created users.")],-1),pe=s("div",{class:"right"},[s("h3",{id:"rest-api-5"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`POST /users
|
|
78
|
-
`)]),s("h5",{id:"example-7"},[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(`
|
|
79
|
-
|
|
80
|
-
[
|
|
81
|
-
{
|
|
82
|
-
`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"admin@example.com"'),e(`,
|
|
83
|
-
`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"p455w0rd"'),e(`,
|
|
84
|
-
`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
|
|
85
|
-
},
|
|
86
|
-
{
|
|
87
|
-
`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"another@example.com"'),e(`,
|
|
88
|
-
`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`,
|
|
89
|
-
`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
|
|
90
|
-
}
|
|
91
|
-
]
|
|
92
|
-
`)])]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
93
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
|
|
94
|
-
create_users_items(data: [create_directus_users_input!]!): [directus_users]
|
|
95
|
-
}
|
|
96
|
-
`)])]),s("h5",{id:"example-8"},[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(` {
|
|
97
|
-
create_users_items(
|
|
98
|
-
data: [
|
|
99
|
-
{ 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(` }
|
|
100
|
-
{ 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(` }
|
|
101
|
-
]
|
|
102
|
-
) {
|
|
103
|
-
email
|
|
104
|
-
role
|
|
105
|
-
}
|
|
106
|
-
}
|
|
107
|
-
`)])])],-1),_e=s("hr",null,null,-1),ge=s("h2",{id:"update-a-user"},[e("Update a User "),s("a",{class:"header-anchor",href:"#update-a-user"},"#")],-1),fe=s("p",null,"Update an existing user.",-1),me={class:"two-up"},je={class:"left"},ye=s("h3",{id:"query-parameters-6"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),be=e("Supports all "),qe=e("global query parameters"),ve=e("."),we=s("h3",{id:"request-body-3"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),xe=s("p",null,[e("A partial "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),Te=s("h3",{id:"returns-6"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Ee=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the updated user.")],-1),Re=s("div",{class:"right"},[s("h3",{id:"rest-api-6"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",null,`PATCH /users/:id
|
|
108
|
-
`)]),s("h5",{id:"example-9"},[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(`
|
|
109
|
-
|
|
110
|
-
{
|
|
111
|
-
`),s("span",{class:"hljs-attr"},'"title"'),e(": "),s("span",{class:"hljs-string"},'"CTO"'),e(`
|
|
112
|
-
}
|
|
113
|
-
`)])]),s("h3",{id:"graphql-6"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
114
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
|
|
115
|
-
update_users_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_users_input!): directus_users
|
|
116
|
-
}
|
|
117
|
-
`)])]),s("h5",{id:"example-10"},[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(` {
|
|
118
|
-
update_users_item(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", data: { title: "),s("span",{class:"hljs-string"},'"CTO"'),e(` }) {
|
|
119
|
-
first_name
|
|
120
|
-
last_name
|
|
121
|
-
}
|
|
122
|
-
}
|
|
123
|
-
`)])])],-1),Se=s("hr",null,null,-1),Pe=s("h2",{id:"update-multiple-users"},[e("Update Multiple Users "),s("a",{class:"header-anchor",href:"#update-multiple-users"},"#")],-1),ke=s("p",null,"Update multiple existing users.",-1),Ae={class:"two-up"},Ue={class:"left"},Oe=s("h3",{id:"query-parameters-7"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-7"},"#")],-1),Le=e("Supports all "),Ie=e("global query parameters"),Ce=e("."),Qe=s("h3",{id:"request-body-4"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),De=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),Ge=s("h3",{id:"returns-7"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-7"},"#")],-1),Be=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user objects"),e(" for the updated users.")],-1),Me=s("div",{class:"right"},[s("h3",{id:"rest-api-7"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",null,`PATCH /users
|
|
124
|
-
`)]),s("h5",{id:"example-11"},[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(`
|
|
125
|
-
|
|
126
|
-
{
|
|
127
|
-
`),s("span",{class:"hljs-attr"},'"keys"'),e(": ["),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", "),s("span",{class:"hljs-string"},'"9c3d75a8-7a5f-41a4-be0a-1488fd974511"'),e(`],
|
|
128
|
-
`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
|
|
129
|
-
`),s("span",{class:"hljs-attr"},'"title"'),e(": "),s("span",{class:"hljs-string"},'"CTO"'),e(`
|
|
130
|
-
}
|
|
131
|
-
}
|
|
132
|
-
`)])]),s("h3",{id:"graphql-7"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
133
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
|
|
134
|
-
update_users_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_users_input!): [directus_users]
|
|
135
|
-
}
|
|
136
|
-
`)])]),s("h5",{id:"example-12"},[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(` {
|
|
137
|
-
update_users_items(
|
|
138
|
-
ids: [`),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", "),s("span",{class:"hljs-string"},'"9c3d75a8-7a5f-41a4-be0a-1488fd974511"'),e(`]
|
|
139
|
-
data: { title: `),s("span",{class:"hljs-string"},'"CTO"'),e(` }
|
|
140
|
-
) {
|
|
141
|
-
first_name
|
|
142
|
-
last_name
|
|
143
|
-
}
|
|
144
|
-
}
|
|
145
|
-
`)])])],-1),Fe=s("hr",null,null,-1),He=s("h2",{id:"delete-a-user"},[e("Delete a User "),s("a",{class:"header-anchor",href:"#delete-a-user"},"#")],-1),Ne=s("p",null,"Delete an existing user.",-1),We=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-8"},[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"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),s("pre",null,[s("code",null,`DELETE /users/:id
|
|
146
|
-
`)]),s("h5",{id:"example-13"},[e("Example "),s("a",{class:"header-anchor",href:"#example-13"},"#")]),s("pre",null,[s("code",null,`DELETE /users/72a1ce24-4748-47de-a05f-ce9af3033727
|
|
147
|
-
`)]),s("h3",{id:"graphql-8"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-8"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
148
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
|
|
149
|
-
delete_users_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
|
|
150
|
-
}
|
|
151
|
-
`)])]),s("h5",{id:"example-14"},[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(` {
|
|
152
|
-
delete_users_item(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(`) {
|
|
153
|
-
id
|
|
154
|
-
}
|
|
155
|
-
}
|
|
156
|
-
`)])])])],-1),Ve=s("hr",null,null,-1),Ye=s("h2",{id:"delete-multiple-users"},[e("Delete Multiple Users "),s("a",{class:"header-anchor",href:"#delete-multiple-users"},"#")],-1),ze=s("p",null,"Delete multiple existing users.",-1),Je=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-5"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"An array of user primary keys"),s("h3",{id:"returns-9"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-9"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-9"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-9"},"#")]),s("pre",null,[s("code",null,`DELETE /users
|
|
157
|
-
`)]),s("h5",{id:"example-15"},[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(`
|
|
158
|
-
[`),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(", "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`]
|
|
159
|
-
`)])]),s("h3",{id:"graphql-9"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-9"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
160
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
|
|
161
|
-
delete_users_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
|
|
162
|
-
}
|
|
163
|
-
`)])]),s("h5",{id:"example-16"},[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(` {
|
|
164
|
-
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(`]) {
|
|
165
|
-
ids
|
|
166
|
-
}
|
|
167
|
-
}
|
|
168
|
-
`)])])])],-1),Ke=s("hr",null,null,-1),Xe=s("h2",{id:"invite-a-new-user"},[e("Invite a new User "),s("a",{class:"header-anchor",href:"#invite-a-new-user"},"#")],-1),Ze=s("p",null,"Invite a new user by email.",-1),$e={class:"two-up"},sa={class:"left"},ea=s("h3",{id:"request-body-6"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-6"},"#")],-1),aa={class:"definitions"},ta=s("p",null,[s("code",null,"email"),e(),s("strong",null,"Required"),s("br"),e(" User email to invite.")],-1),la=s("p",null,[s("code",null,"role"),e(),s("strong",null,"Required"),s("br"),e(" Role of the new user.")],-1),na=s("code",null,"invite_url",-1),ra=s("br",null,null,-1),ca=e(" Provide a custom invite url which the link in the email will lead to. The invite token will be passed as a parameter."),oa=s("br",null,null,-1),ha=s("strong",null,"Note",-1),ia=e(": You need to configure the "),da=s("code",null,"USER_INVITE_URL_ALLOW_LIST",-1),ua=e(" environment variable"),pa=e(" to enable this feature."),_a=s("h3",{id:"returns-10"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-10"},"#")],-1),ga=s("p",null,"Empty body.",-1),fa=s("div",{class:"right"},[s("h3",{id:"rest-api-10"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-10"},"#")]),s("pre",null,[s("code",null,`POST /users/invite
|
|
169
|
-
`)]),s("h5",{id:"example-17"},[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(`
|
|
170
|
-
|
|
171
|
-
{
|
|
172
|
-
`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"another@example.com"'),e(`,
|
|
173
|
-
`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
|
|
174
|
-
}
|
|
175
|
-
`)])]),s("h3",{id:"graphql-10"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-10"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
176
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
|
|
177
|
-
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(`
|
|
178
|
-
}
|
|
179
|
-
`)])]),s("h5",{id:"example-18"},[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(` {
|
|
180
|
-
users_invite(email: `),s("span",{class:"hljs-string"},'"another@example.com"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`)
|
|
181
|
-
}
|
|
182
|
-
`)])])],-1),ma=s("hr",null,null,-1),ja=s("h2",{id:"accept-user-invite"},[e("Accept User Invite "),s("a",{class:"header-anchor",href:"#accept-user-invite"},"#")],-1),ya=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),ba=s("p",null,"This link includes a token, which is then used to activate the invited user.",-1),qa=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-7"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-7"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",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"},[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"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-11"},"#")]),s("pre",null,[s("code",null,`POST /users/invite/accept
|
|
183
|
-
`)]),s("h5",{id:"example-19"},[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(`
|
|
184
|
-
|
|
185
|
-
{
|
|
186
|
-
`),s("span",{class:"hljs-attr"},'"token"'),e(": "),s("span",{class:"hljs-string"},'"eyJh...KmUk"'),e(`,
|
|
187
|
-
`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`
|
|
188
|
-
}
|
|
189
|
-
`)])]),s("h3",{id:"graphql-11"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-11"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
190
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
|
|
191
|
-
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(`
|
|
192
|
-
}
|
|
193
|
-
`)])]),s("h5",{id:"example-20"},[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(` {
|
|
194
|
-
users_invite_accept(token: `),s("span",{class:"hljs-string"},'"eyJh...KmUk"'),e(", password: "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`)
|
|
195
|
-
}
|
|
196
|
-
`)])])])],-1),va=s("hr",null,null,-1),wa=s("h2",{id:"generate-two-factor-authentication-secret"},[e("Generate Two-Factor Authentication Secret "),s("a",{class:"header-anchor",href:"#generate-two-factor-authentication-secret"},"#")],-1),xa=s("p",null,"Generates a secret and returns the URL to be used in an authenticator app.",-1),Ta=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-8"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-8"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"password"),e(),s("strong",null,"Required"),s("br"),e(" The user\u2019s password.")])]),s("h3",{id:"returns-12"},[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"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-12"},"#")]),s("pre",null,[s("code",null,`POST /users/me/tfa/generate
|
|
197
|
-
`)]),s("h5",{id:"example-21"},[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(`
|
|
198
|
-
{
|
|
199
|
-
`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`
|
|
200
|
-
}
|
|
201
|
-
`)])]),s("h3",{id:"graphql-12"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-12"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
202
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
|
|
203
|
-
users_me_tfa_generate(password:`),s("span",{class:"hljs-type"}," String"),e(`!): users_me_tfa_generate_data
|
|
204
|
-
}
|
|
205
|
-
`)])]),s("h5",{id:"example-22"},[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(` {
|
|
206
|
-
users_me_tfa_generate(password: `),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`) {
|
|
207
|
-
secret
|
|
208
|
-
otpauth_url
|
|
209
|
-
}
|
|
210
|
-
}
|
|
211
|
-
`)])])])],-1),Ea=s("hr",null,null,-1),Ra=s("h2",{id:"enable-two-factor-authentication"},[e("Enable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#enable-two-factor-authentication"},"#")],-1),Sa=s("p",null,"Adds a TFA secret to the user account.",-1),Pa=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-9"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-9"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",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"},[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"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-13"},"#")]),s("pre",null,[s("code",null,`POST /users/me/tfa/enable
|
|
212
|
-
`)]),s("h5",{id:"example-23"},[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(`
|
|
213
|
-
{
|
|
214
|
-
`),s("span",{class:"hljs-attr"},'"otp"'),e(": "),s("span",{class:"hljs-string"},'"123456"'),e(`,
|
|
215
|
-
`),s("span",{class:"hljs-attr"},'"secret"'),e(": "),s("span",{class:"hljs-string"},'"3CtiutsNBmY3szHE"'),e(`
|
|
216
|
-
}
|
|
217
|
-
`)])]),s("h3",{id:"graphql-13"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-13"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
218
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
|
|
219
|
-
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(`
|
|
220
|
-
}
|
|
221
|
-
`)])]),s("h5",{id:"example-24"},[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(` {
|
|
222
|
-
users_me_tfa_enable(otp: `),s("span",{class:"hljs-string"},'"123456"'),e(", secret: "),s("span",{class:"hljs-string"},'"3CtiutsNBmY3szHE"'),e(`)
|
|
223
|
-
}
|
|
224
|
-
`)])])])],-1),ka=s("hr",null,null,-1),Aa=s("h2",{id:"disable-two-factor-authentication"},[e("Disable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#disable-two-factor-authentication"},"#")],-1),Ua=s("p",null,"Disables two-factor authentication by removing the OTP secret from the user.",-1),Oa=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-10"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-10"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"otp"),e(),s("strong",null,"Required"),s("br"),e(" One-time password generated by the authenticator app.")])]),s("h3",{id:"returns-14"},[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"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-14"},"#")]),s("pre",null,[s("code",null,`POST /users/me/tfa/disable
|
|
225
|
-
`)]),s("h5",{id:"example-25"},[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(`
|
|
226
|
-
|
|
227
|
-
{
|
|
228
|
-
`),s("span",{class:"hljs-attr"},'"otp"'),e(": "),s("span",{class:"hljs-string"},'"859014"'),e(`
|
|
229
|
-
}
|
|
230
|
-
`)])]),s("h3",{id:"graphql-14"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-14"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
|
|
231
|
-
`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
|
|
232
|
-
users_me_tfa_disable(otp:`),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
|
|
233
|
-
}
|
|
234
|
-
`)])]),s("h5",{id:"example-26"},[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(` {
|
|
235
|
-
users_me_tfa_disable(otp: `),s("span",{class:"hljs-string"},'"591763"'),e(`)
|
|
236
|
-
}
|
|
237
|
-
`)])])])],-1),Da={setup(La,{expose:c}){const n={title:"Users",modularExtension:!1,pageClass:"page-reference"};return c({frontmatter:n}),(Ia,Ca)=>{const t=r("router-link"),o=r("DocsWrapper");return h(),i(o,{frontmatter:n},{default:a(()=>[s("div",d,[s("div",u,[s("div",p,[s("blockquote",null,[s("p",null,[_,l(t,{to:"/docs/getting-started/glossary/#users/"},{default:a(()=>[g]),_:1}),f])])]),m]),j,y,s("div",b,[s("div",q,[s("div",v,[w,x,T,E,R,S,P,k,A,s("p",null,[U,O,L,I,C,l(t,{to:"/docs/reference/files/"},{default:a(()=>[Q]),_:1}),D]),G,B,M,F])]),H]),N,W,V,s("div",Y,[s("div",z,[J,s("p",null,[K,l(t,{to:"/docs/reference/query"},{default:a(()=>[X]),_:1}),Z]),$,s("p",null,[ss,l(t,{to:"/docs/reference/query/#limit"},{default:a(()=>[es]),_:1}),as,ts,ls])]),s("div",ns,[rs,cs,s("p",null,[l(t,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[os]),_:1})]),hs,is,ds,us,ps])]),_s,gs,fs,s("div",ms,[s("div",js,[ys,s("p",null,[bs,l(t,{to:"/docs/reference/query"},{default:a(()=>[qs]),_:1}),vs]),ws,xs]),Ts]),Es,Rs,Ss,s("div",Ps,[s("div",ks,[As,s("p",null,[Us,l(t,{to:"/docs/reference/query"},{default:a(()=>[Os]),_:1}),Ls]),Is,Cs]),Qs]),Ds,Gs,Bs,s("div",Ms,[s("div",Fs,[Hs,s("p",null,[Ns,l(t,{to:"/docs/reference/query"},{default:a(()=>[Ws]),_:1}),Vs]),Ys,zs,Js,Ks,Xs]),Zs]),$s,se,ee,s("div",ae,[s("div",te,[le,s("p",null,[ne,l(t,{to:"/docs/reference/query"},{default:a(()=>[re]),_:1}),ce]),oe,he,ie,de,ue]),pe]),_e,ge,fe,s("div",me,[s("div",je,[ye,s("p",null,[be,l(t,{to:"/docs/reference/query"},{default:a(()=>[qe]),_:1}),ve]),we,xe,Te,Ee]),Re]),Se,Pe,ke,s("div",Ae,[s("div",Ue,[Oe,s("p",null,[Le,l(t,{to:"/docs/reference/query"},{default:a(()=>[Ie]),_:1}),Ce]),Qe,De,Ge,Be]),Me]),Fe,He,Ne,We,Ve,Ye,ze,Je,Ke,Xe,Ze,s("div",$e,[s("div",sa,[ea,s("div",aa,[ta,la,s("p",null,[na,ra,ca,oa,ha,ia,l(t,{to:"/docs/configuration/config-options/#security"},{default:a(()=>[da,ua]),_:1}),pa])]),_a,ga]),fa]),ma,ja,ya,ba,qa,va,wa,xa,Ta,Ea,Ra,Sa,Pa,ka,Aa,Ua,Oa])]),_:1})}}};export{Da as default};
|