@directus/app 9.14.1 → 9.14.2

package/dist/assets/roles.22f7aa37.js

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