@directus/app 9.15.0 → 9.16.1

package/dist/assets/roles.b0107422.js

@@ -1,171 +0,0 @@
-import{a as r,o as h,b as i,w as a,g as s,e as t,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.js";const d={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=e("Roles define a specific set of access permissions, and are the primary organizational structure for Users within the platform. "),j=e("Learn more about Roles"),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-role-object"}," The Role Object")]),s("li",null,[s("a",{href:"#list-roles"}," List Roles")]),s("li",null,[s("a",{href:"#retrieve-a-role"}," Retrieve a Role")]),s("li",null,[s("a",{href:"#create-a-role"}," Create a Role")]),s("li",null,[s("a",{href:"#create-multiple-roles"}," Create Multiple Roles")]),s("li",null,[s("a",{href:"#update-a-role"}," Update a Role")]),s("li",null,[s("a",{href:"#update-multiple-roles"}," Update Multiple Roles")]),s("li",null,[s("a",{href:"#delete-a-role"}," Delete a Role")]),s("li",null,[s("a",{href:"#delete-multiple-roles"}," Delete Multiple Roles")])])])])],-1),g=s("hr",null,null,-1),b=s("h2",{id:"the-role-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-role-object"},"#"),e(" The Role Object")],-1),y={class:"two-up"},x={class:"left"},q={class:"definitions"},R=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the role.")],-1),w=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Name of the role.")],-1),v=s("p",null,[s("code",null,"icon"),e(),s("strong",null,"string"),s("br"),e(" Icon for the role. Displayed in the Admin App.")],-1),E=s("p",null,[s("code",null,"description"),e(),s("strong",null,"string"),s("br"),e(" Description for the role. Displayed in the Admin App.")],-1),k=s("p",null,[s("code",null,"ip_access"),e(),s("strong",null,"csv"),s("br"),e(" CSV of IP addresses that have access to this role. Allows you to configure an allowlist of IP addresses.")],-1),T=s("p",null,[s("code",null,"enforce_tfa"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not Two-Factor Authentication is required for users in this role.")],-1),P=s("p",null,[s("code",null,"admin_access"),e(),s("strong",null,"boolean"),s("br"),e(" If this role is considered an admin role. This means that users in this role have full permissions to everything.")],-1),A=s("p",null,[s("code",null,"app_access"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not users in this role have access to use the Admin App.")],-1),S=s("code",null,"users",-1),I=e(),C=s("strong",null,"one-to-many",-1),D=s("br",null,null,-1),L=e(" The users in this role. One-to-many to "),Q=e("users"),O=e("."),M=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"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Admin"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"supervised_user_circle"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"ip_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"enforce_tfa"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"users"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),s("span",{class:"hljs-punctuation"},"]"),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])])],-1),G=s("hr",null,null,-1),B=s("h2",{id:"list-roles",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-roles"},"#"),e(" List Roles")],-1),U=s("p",null,"List all roles that exist in Directus.",-1),H={class:"two-up"},N={class:"left"},V=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),e(" Query Parameters")],-1),W=e("Supports all "),z=e("global query parameters"),F=e("."),J=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),e(" Returns")],-1),K=e("An array of up to "),X=e("limit"),Y=e(),Z=s("a",{href:"#the-role-object"},"role objects",-1),$=e(". If no items are available, data will be an empty array."),ss={class:"right"},es=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),e(" REST API")],-1),as=s("pre",null,[s("code",null,`GET /roles
-SEARCH /roles
-`)],-1),ls=e("Learn more about SEARCH ->"),ts=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),e(" GraphQL")],-1),ns=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),rs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	roles: [directus_roles]
-}
-`)])],-1),os=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),e(" Example")],-1),cs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	roles {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])],-1),hs=s("hr",null,null,-1),is=s("h2",{id:"retrieve-a-role",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-a-role"},"#"),e(" Retrieve a Role")],-1),ds=s("p",null,"List an existing role by primary key.",-1),ps={class:"two-up"},us={class:"left"},_s=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),e(" Query Parameters")],-1),js=e("Supports all "),fs=e("global query parameters"),ms=e("."),gs=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),e(" Returns")],-1),bs=s("p",null,[e("Returns the requested "),s("a",{href:"#the-role-object"},"role object"),e(".")],-1),ys=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 /roles/: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 /roles/b4cb3b64-8580-4ad9-a099-eade6da24302
-`)]),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(` {
-	roles_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_roles
-}
-`)])]),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(` {
-	roles_by_id(id: `),s("span",{class:"hljs-number"},"2"),e(`) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),xs=s("hr",null,null,-1),qs=s("h2",{id:"create-a-role",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-a-role"},"#"),e(" Create a Role")],-1),Rs=s("p",null,"Create a new role.",-1),ws={class:"two-up"},vs={class:"left"},Es=s("h3",{id:"query-parameters-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),e(" Query Parameters")],-1),ks=e("Supports all "),Ts=e("global query parameters"),Ps=e("."),As=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),e(" Request Body")],-1),Ss=s("p",null,[e("A partial "),s("a",{href:"#the-role-object"},"role object"),e(".")],-1),Is=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),e(" Returns")],-1),Cs=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role object"),e(" for the created role.")],-1),Ds=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,`POST /roles
-`)]),s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),e(" Example")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /roles"),e(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),e(`
-	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Interns"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"verified_user"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])]),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"}," Mutation"),e(` {
-	create_roles_item(data: create_directus_roles_input!): directus_roles
-}
-`)])]),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(` {
-	create_roles_item(
-		data: { name: `),s("span",{class:"hljs-string"},'"Interns"'),e(", icon: "),s("span",{class:"hljs-string"},'"verified_user"'),e(", description: "),s("span",{class:"hljs-literal"},"null"),e(", admin_access: "),s("span",{class:"hljs-literal"},"false"),e(", app_access: "),s("span",{class:"hljs-literal"},"true"),e(` }
-	) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),Ls=s("hr",null,null,-1),Qs=s("h2",{id:"create-multiple-roles",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-multiple-roles"},"#"),e(" Create Multiple Roles")],-1),Os=s("p",null,"Create multiple new roles.",-1),Ms={class:"two-up"},Gs={class:"left"},Bs=s("h3",{id:"query-parameters-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),e(" Query Parameters")],-1),Us=e("Supports all "),Hs=e("global query parameters"),Ns=e("."),Vs=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),e(" Request Body")],-1),Ws=s("p",null,[e("An array of partial "),s("a",{href:"#the-role-object"},"role objects"),e(".")],-1),zs=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),e(" Returns")],-1),Fs=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role objects"),e(" for the created roles.")],-1),Js=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,`POST /roles
-`)]),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 /roles"),e(`
-
-`),s("span",{class:"hljs-punctuation"},"["),e(`
-	`),s("span",{class:"hljs-punctuation"},"{"),e(`
-		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Interns"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"verified_user"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),e(`
-	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-punctuation"},"{"),e(`
-		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Customers"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"person"'),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),e(`
-		`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),e(`
-	`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`),s("span",{class:"hljs-punctuation"},"]"),e(`
-`)])]),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(` {
-	create_roles_items(data: [create_directus_roles_input!]!): [directus_roles]
-}
-`)])]),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_roles_items(
-		data: [
-			{ name: `),s("span",{class:"hljs-string"},'"Interns"'),e(", icon: "),s("span",{class:"hljs-string"},'"verified_user"'),e(", description: "),s("span",{class:"hljs-literal"},"null"),e(", admin_access: "),s("span",{class:"hljs-literal"},"false"),e(", app_access: "),s("span",{class:"hljs-literal"},"true"),e(` }
-			{ name: `),s("span",{class:"hljs-string"},'"Customers"'),e(", icon: "),s("span",{class:"hljs-string"},'"person"'),e(", description: "),s("span",{class:"hljs-literal"},"null"),e(", admin_access: "),s("span",{class:"hljs-literal"},"false"),e(", app_access: "),s("span",{class:"hljs-literal"},"false"),e(` }
-		]
-	) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),Ks=s("hr",null,null,-1),Xs=s("h2",{id:"update-a-role",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-role"},"#"),e(" Update a Role")],-1),Ys=s("p",null,"Update an existing role.",-1),Zs={class:"two-up"},$s={class:"left"},se=s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),e(" Query Parameters")],-1),ee=e("Supports all "),ae=e("global query parameters"),le=e("."),te=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),e(" Request Body")],-1),ne=s("p",null,[e("A partial "),s("a",{href:"#the-role-object"},"role object"),e(".")],-1),re=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),e(" Returns")],-1),oe=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role object"),e(" for the updated role.")],-1),ce=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,`PATCH /roles/:id
-`)]),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"},"// PATCH /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7"),e(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),e(`
-	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"attractions"'),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])]),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(` {
-	update_roles_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_roles_input): directus_roles
-}
-`)])]),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(` {
-	update_roles_item(id: `),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", data: { icon: "),s("span",{class:"hljs-string"},'"attractions"'),e(` }) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),he=s("hr",null,null,-1),ie=s("h2",{id:"update-multiple-roles",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-multiple-roles"},"#"),e(" Update Multiple Roles")],-1),de=s("p",null,"Update multiple existing roles.",-1),pe={class:"two-up"},ue={class:"left"},_e=s("h3",{id:"query-parameters-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-5"},"#"),e(" Query Parameters")],-1),je=e("Supports all "),fe=e("global query parameters"),me=e("."),ge=s("h3",{id:"request-body-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-3"},"#"),e(" Request Body")],-1),be=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 roles 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-role-object"},"the role object"),e("\u2019s properties.")])],-1),ye=s("h3",{id:"returns-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-5"},"#"),e(" Returns")],-1),xe=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role objects"),e(" for the updated roles.")],-1),qe=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,`PATCH /roles
-`)]),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 /roles"),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"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"6fc3d5d3-a37b-4da8-a2f4-ed62ad5abe03"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
-		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"attractions"'),e(`
-	`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])]),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(` {
-	update_roles_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_roles_input): [directus_roles]
-}
-`)])]),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_roles_items(
-		ids: [`),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", "),s("span",{class:"hljs-string"},'"6fc3d5d3-a37b-4da8-a2f4-ed62ad5abe03"'),e(`]
-		data: { icon: `),s("span",{class:"hljs-string"},'"attractions"'),e(` }
-	) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),Re=s("hr",null,null,-1),we=s("h2",{id:"delete-a-role",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-a-role"},"#"),e(" Delete a Role")],-1),ve=s("p",null,"Delete an existing role.",-1),Ee=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-6"},"#"),e(" Returns")]),s("p",null,"Empty body.")]),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,`DELETE /roles/:id
-`)]),s("h5",{id:"example-11",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-11"},"#"),e(" Example")]),s("pre",null,[s("code",null,`DELETE /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7
-`)]),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(` {
-	delete_roles_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
-}
-`)])]),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(` {
-	delete_roles_item(id: `),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`) {
-		id
-	}
-}
-`)])])])],-1),ke=s("hr",null,null,-1),Te=s("h2",{id:"delete-multiple-roles",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-multiple-roles"},"#"),e(" Delete Multiple Roles")],-1),Pe=s("p",null,"Delete multiple existing roles.",-1),Ae=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 role primary keys"),s("h3",{id:"returns-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-7"},"#"),e(" Returns")]),s("p",null,"Empty body.")]),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,`DELETE /roles
-`)]),s("h5",{id:"example-13",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-13"},"#"),e(" Example")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /roles"),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-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(` {
-	delete_roles_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
-}
-`)])]),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_roles_items(ids: [`),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(", "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`]) {
-		ids
-	}
-}
-`)])])])],-1),Se=s("hr",null,null,-1),Qe="Roles",Oe=!1,Me="page-reference",Ge={name:"roles",setup(Ie,{expose:o}){const n={title:"Roles",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:n}),(Ce,De)=>{const l=r("router-link"),c=r("docs-wrapper");return h(),i(c,{frontmatter:n},{default:a(()=>[s("div",d,[s("div",p,[s("div",u,[s("blockquote",null,[s("p",null,[_,t(l,{to:"/docs/getting-started/glossary/#roles"},{default:a(()=>[j]),_:1}),f])])]),m]),g,b,s("div",y,[s("div",x,[s("div",q,[R,w,v,E,k,T,P,A,s("p",null,[S,I,C,D,L,t(l,{to:"/docs/reference/system/users/"},{default:a(()=>[Q]),_:1}),O])])]),M]),G,B,U,s("div",H,[s("div",N,[V,s("p",null,[W,t(l,{to:"/docs/reference/query"},{default:a(()=>[z]),_:1}),F]),J,s("p",null,[K,t(l,{to:"/docs/reference/query/#limit"},{default:a(()=>[X]),_:1}),Y,Z,$])]),s("div",ss,[es,as,s("p",null,[t(l,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[ls]),_:1})]),ts,ns,rs,os,cs])]),hs,is,ds,s("div",ps,[s("div",us,[_s,s("p",null,[js,t(l,{to:"/docs/reference/query"},{default:a(()=>[fs]),_:1}),ms]),gs,bs]),ys]),xs,qs,Rs,s("div",ws,[s("div",vs,[Es,s("p",null,[ks,t(l,{to:"/docs/reference/query"},{default:a(()=>[Ts]),_:1}),Ps]),As,Ss,Is,Cs]),Ds]),Ls,Qs,Os,s("div",Ms,[s("div",Gs,[Bs,s("p",null,[Us,t(l,{to:"/docs/reference/query"},{default:a(()=>[Hs]),_:1}),Ns]),Vs,Ws,zs,Fs]),Js]),Ks,Xs,Ys,s("div",Zs,[s("div",$s,[se,s("p",null,[ee,t(l,{to:"/docs/reference/query"},{default:a(()=>[ae]),_:1}),le]),te,ne,re,oe]),ce]),he,ie,de,s("div",pe,[s("div",ue,[_e,s("p",null,[je,t(l,{to:"/docs/reference/query"},{default:a(()=>[fe]),_:1}),me]),ge,be,ye,xe]),qe]),Re,we,ve,Ee,ke,Te,Pe,Ae,Se])]),_:1})}}};export{Ge as default,Oe as modularExtension,Me as pageClass,Qe as title};