@directus/app 9.12.0 → 9.13.0

package/dist/assets/roles.caf226aa.js

@@ -0,0 +1,171 @@
+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.e6808e6c.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),j=e("hr",null,null,-1),y=e("h2",{id:"the-role-object"},[s("The Role Object "),e("a",{class:"header-anchor",href:"#the-role-object"},"#")],-1),b={class:"two-up"},q={class:"left"},x={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"},[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"},[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"},[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"},[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"},[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"},[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"},[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-2"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),fe=s("Supports all "),me=s("global query parameters"),ge=s("."),je=e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ye=e("p",null,[s("Returns the requested "),e("a",{href:"#the-role-object"},"role object"),s(".")],-1),be=e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`GET /roles/:id
+`)]),e("h5",{id:"example-2"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",null,`GET /roles/b4cb3b64-8580-4ad9-a099-eade6da24302
+`)]),e("h3",{id:"graphql-2"},[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"}," Query"),s(` {
+	roles_by_id(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): directus_roles
+}
+`)])]),e("h5",{id:"example-3"},[s("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),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),qe=e("hr",null,null,-1),xe=e("h2",{id:"create-a-role"},[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-3"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Te=s("Supports all "),Pe=s("global query parameters"),Ae=s("."),ke=e("h3",{id:"request-body"},[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-3"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")],-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-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /roles
+`)]),e("h5",{id:"example-4"},[s("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),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-3"},[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_item(data: create_directus_roles_input!): directus_roles
+}
+`)])]),e("h5",{id:"example-5"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),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"},[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-4"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Ue=s("Supports all "),He=s("global query parameters"),Ne=s("."),Ve=e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")],-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-4"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-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-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`POST /roles
+`)]),e("h5",{id:"example-6"},[s("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),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-4"},[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(` {
+	create_roles_items(data: [create_directus_roles_input!]!): [directus_roles]
+}
+`)])]),e("h5",{id:"example-7"},[s("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),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"},[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-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),ss=s("Supports all "),as=s("global query parameters"),ls=s("."),ts=e("h3",{id:"request-body-3"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),ns=e("p",null,[s("A partial "),e("a",{href:"#the-role-object"},"role object"),s(".")],-1),rs=e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")],-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-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /roles/:id
+`)]),e("h5",{id:"example-8"},[s("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),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-5"},[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_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!, data: update_directus_roles_input): directus_roles
+}
+`)])]),e("h5",{id:"example-9"},[s("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),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"},[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-6"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),fs=s("Supports all "),ms=s("global query parameters"),gs=s("."),js=e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),ys=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),bs=e("h3",{id:"returns-6"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),qs=e("p",null,[s("Returns the "),e("a",{href:"#the-role-object"},"role objects"),s(" for the updated roles.")],-1),xs=e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`PATCH /roles
+`)]),e("h5",{id:"example-10"},[s("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),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-6"},[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(` {
+	update_roles_items(ids: `),e("span",{class:"hljs-literal"},"[ID"),s(`!]!, data: update_directus_roles_input): [directus_roles]
+}
+`)])]),e("h5",{id:"example-11"},[s("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),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"},[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-7"},[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"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",null,`DELETE /roles/:id
+`)]),e("h5",{id:"example-12"},[s("Example "),e("a",{class:"header-anchor",href:"#example-12"},"#")]),e("pre",null,[e("code",null,`DELETE /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7
+`)]),e("h3",{id:"graphql-7"},[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_item(id:`),e("span",{class:"hljs-literal"}," ID"),s(`!): delete_one
+}
+`)])]),e("h5",{id:"example-13"},[s("Example "),e("a",{class:"header-anchor",href:"#example-13"},"#")]),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"},[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-5"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-5"},"#")]),e("p",null,"An array of role primary keys"),e("h3",{id:"returns-8"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-8"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-8"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),e("pre",null,[e("code",null,`DELETE /roles
+`)]),e("h5",{id:"example-14"},[s("Example "),e("a",{class:"header-anchor",href:"#example-14"},"#")]),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-8"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-8"},"#")]),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-15"},[s("Example "),e("a",{class:"header-anchor",href:"#example-15"},"#")]),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]),j,y,e("div",b,[e("div",q,[e("div",x,[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]),je,ye]),be]),qe,xe,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]),js,ys,bs,qs]),xs]),Rs,vs,Es,ws,Ts,Ps,As,ks,Ss])]),_:1})}}};export{Gs as default,Os as modularExtension,Ms as pageClass,Qs as title};

package/dist/assets/rpm.b64d60a3.js

@@ -0,0 +1 @@
+import{A as d}from"./index.876852bd.entry.js";function m(i,f){return f.forEach(function(e){e&&typeof e!="string"&&!Array.isArray(e)&&Object.keys(e).forEach(function(n){if(n!=="default"&&!(n in i)){var c=Object.getOwnPropertyDescriptor(e,n);Object.defineProperty(i,n,c.get?c:{enumerable:!0,get:function(){return e[n]}})}})}),Object.freeze(Object.defineProperty(i,Symbol.toStringTag,{value:"Module"}))}var p={exports:{}};(function(i,f){(function(e){e(d.exports)})(function(e){e.defineMode("rpm-changes",function(){var n=/^-+$/,c=/^(Mon|Tue|Wed|Thu|Fri|Sat|Sun) (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)  ?\d{1,2} \d{2}:\d{2}(:\d{2})? [A-Z]{3,4} \d{4} - /,a=/^[\w+.-]+@[\w.-]+/;return{token:function(o){return o.sol()&&(o.match(n)||o.match(c))?"tag":o.match(a)?"string":(o.next(),null)}}}),e.defineMIME("text/x-rpm-changes","rpm-changes"),e.defineMode("rpm-spec",function(){var n=/^(i386|i586|i686|x86_64|ppc64le|ppc64|ppc|ia64|s390x|s390|sparc64|sparcv9|sparc|noarch|alphaev6|alpha|hppa|mipsel)/,c=/^[a-zA-Z0-9()]+:/,a=/^%(debug_package|package|description|prep|build|install|files|clean|changelog|preinstall|preun|postinstall|postun|pretrans|posttrans|pre|post|triggerin|triggerun|verifyscript|check|triggerpostun|triggerprein|trigger)/,o=/^%(ifnarch|ifarch|if)/,u=/^%(else|endif)/,l=/^(\!|\?|\<\=|\<|\>\=|\>|\=\=|\&\&|\|\|)/;return{startState:function(){return{controlFlow:!1,macroParameters:!1,section:!1}},token:function(r,t){var h=r.peek();if(h=="#")return r.skipToEnd(),"comment";if(r.sol()){if(r.match(c))return"header";if(r.match(a))return"atom"}if(r.match(/^\$\w+/)||r.match(/^\$\{\w+\}/))return"def";if(r.match(u))return"keyword";if(r.match(o))return t.controlFlow=!0,"keyword";if(t.controlFlow){if(r.match(l))return"operator";if(r.match(/^(\d+)/))return"number";r.eol()&&(t.controlFlow=!1)}if(r.match(n))return r.eol()&&(t.controlFlow=!1),"number";if(r.match(/^%[\w]+/))return r.match("(")&&(t.macroParameters=!0),"keyword";if(t.macroParameters){if(r.match(/^\d+/))return"number";if(r.match(")"))return t.macroParameters=!1,"keyword"}return r.match(/^%\{\??[\w \-\:\!]+\}/)?(r.eol()&&(t.controlFlow=!1),"def"):(r.next(),null)}}}),e.defineMIME("text/x-rpm-spec","rpm-spec")})})();var g=p.exports,v=m({__proto__:null,default:g},[p.exports]);export{v as r};

package/dist/assets/rst.d4af1cd8.js

@@ -0,0 +1 @@
+import{A as oe}from"./index.876852bd.entry.js";import{a as ae}from"./python.a209d75c.js";import{a as ie}from"./stex.49bcb53e.js";import{o as le}from"./overlay.c92748f5.js";function fe(s,I){return I.forEach(function(l){l&&typeof l!="string"&&!Array.isArray(l)&&Object.keys(l).forEach(function(p){if(p!=="default"&&!(p in s)){var i=Object.getOwnPropertyDescriptor(l,p);Object.defineProperty(s,p,i.get?i:{enumerable:!0,get:function(){return l[p]}})}})}),Object.freeze(Object.defineProperty(s,Symbol.toStringTag,{value:"Module"}))}var M={exports:{}};(function(s,I){(function(l){l(oe.exports,ae.exports,ie.exports,le.exports)})(function(l){l.defineMode("rst",function(p,i){var v=/^\*\*[^\*\s](?:[^\*]*[^\*\s])?\*\*/,b=/^\*[^\*\s](?:[^\*]*[^\*\s])?\*/,w=/^``[^`\s](?:[^`]*[^`\s])``/,u=/^(?:[\d]+(?:[\.,]\d+)*)/,E=/^(?:\s\+[\d]+(?:[\.,]\d+)*)/,_=/^(?:\s\-[\d]+(?:[\.,]\d+)*)/,T="[Hh][Tt][Tt][Pp][Ss]?://",P="(?:[\\d\\w.-]+)\\.(?:\\w{2,6})",x="(?:/[\\d\\w\\#\\%\\&\\-\\.\\,\\/\\:\\=\\?\\~]+)*",y=new RegExp("^"+T+P+x),R={token:function(f){if(f.match(v)&&f.match(/\W+|$/,!1))return"strong";if(f.match(b)&&f.match(/\W+|$/,!1))return"em";if(f.match(w)&&f.match(/\W+|$/,!1))return"string-2";if(f.match(u))return"number";if(f.match(E))return"positive";if(f.match(_))return"negative";if(f.match(y))return"link";for(;f.next()!=null&&!(f.match(v,!1)||f.match(b,!1)||f.match(w,!1)||f.match(u,!1)||f.match(E,!1)||f.match(_,!1)||f.match(y,!1)););return null}},W=l.getMode(p,i.backdrop||"rst-base");return l.overlayMode(W,R,!0)},"python","stex"),l.defineMode("rst-base",function(p){function i(n){var e=Array.prototype.slice.call(arguments,1);return n.replace(/{(\d+)}/g,function(r,N){return typeof e[N]!="undefined"?e[N]:r})}var v=l.getMode(p,"python"),b=l.getMode(p,"stex"),w="\\s+",u="(?:\\s*|\\W|$)",E=new RegExp(i("^{0}",u)),_=`(?:[^\\W\\d_](?:[\\w!"#$%&'()\\*\\+,\\-\\./:;<=>\\?]*[^\\W_])?)`,T=new RegExp(i("^{0}",_)),P=`(?:[^\\W\\d_](?:[\\w\\s!"#$%&'()\\*\\+,\\-\\./:;<=>\\?]*[^\\W_])?)`,x=i("(?:{0}|`{1}`)",_,P),y="(?:[^\\s\\|](?:[^\\|]*[^\\s\\|])?)",R="(?:[^\\`]+)",W=new RegExp(i("^{0}",R)),f=new RegExp("^([!'#$%&\"()*+,-./:;<=>?@\\[\\\\\\]^_`{|}~])\\1{3,}\\s*$"),z=new RegExp(i("^\\.\\.{0}",w)),O=new RegExp(i("^_{0}:{1}|^__:{1}",x,u)),A=new RegExp(i("^{0}::{1}",x,u)),S=new RegExp(i("^\\|{0}\\|{1}{2}::{3}",y,w,x,u)),D=new RegExp(i("^\\[(?:\\d+|#{0}?|\\*)]{1}",x,u)),F=new RegExp(i("^\\[{0}\\]{1}",x,u)),j=new RegExp(i("^\\|{0}\\|",y)),H=new RegExp(i("^\\[(?:\\d+|#{0}?|\\*)]_",x)),B=new RegExp(i("^\\[{0}\\]_",x)),G=new RegExp(i("^{0}__?",x)),g=new RegExp(i("^`{0}`_",R)),h=new RegExp(i("^:{0}:`{1}`{2}",_,R,u)),m=new RegExp(i("^`{1}`:{0}:{2}",_,R,u)),$=new RegExp(i("^:{0}:{1}",_,u)),J=new RegExp(i("^{0}",x)),K=new RegExp(i("^::{0}",u)),X=new RegExp(i("^\\|{0}\\|",y)),Q=new RegExp(i("^{0}",w)),U=new RegExp(i("^{0}",x)),V=new RegExp(i("^::{0}",u)),Y=new RegExp("^_"),Z=new RegExp(i("^{0}|_",x)),C=new RegExp(i("^:{0}",u)),ee=new RegExp("^::\\s*$"),ne=new RegExp("^\\s+(?:>>>|In \\[\\d+\\]:)\\s");function o(n,e){var r=null;if(n.sol()&&n.match(ne,!1))c(e,q,{mode:v,local:l.startState(v)});else if(n.sol()&&n.match(z))c(e,t),r="meta";else if(n.sol()&&n.match(f))c(e,o),r="header";else if(k(e)==h||n.match(h,!1))switch(d(e)){case 0:c(e,o,a(h,1)),n.match(/^:/),r="meta";break;case 1:c(e,o,a(h,2)),n.match(T),r="keyword",n.current().match(/^(?:math|latex)/)&&(e.tmp_stex=!0);break;case 2:c(e,o,a(h,3)),n.match(/^:`/),r="meta";break;case 3:if(e.tmp_stex&&(e.tmp_stex=void 0,e.tmp={mode:b,local:l.startState(b)}),e.tmp){if(n.peek()=="`"){c(e,o,a(h,4)),e.tmp=void 0;break}r=e.tmp.mode.token(n,e.tmp.local);break}c(e,o,a(h,4)),n.match(W),r="string";break;case 4:c(e,o,a(h,5)),n.match(/^`/),r="meta";break;case 5:c(e,o,a(h,6)),n.match(E);break;default:c(e,o)}else if(k(e)==m||n.match(m,!1))switch(d(e)){case 0:c(e,o,a(m,1)),n.match(/^`/),r="meta";break;case 1:c(e,o,a(m,2)),n.match(W),r="string";break;case 2:c(e,o,a(m,3)),n.match(/^`:/),r="meta";break;case 3:c(e,o,a(m,4)),n.match(T),r="keyword";break;case 4:c(e,o,a(m,5)),n.match(/^:/),r="meta";break;case 5:c(e,o,a(m,6)),n.match(E);break;default:c(e,o)}else if(k(e)==$||n.match($,!1))switch(d(e)){case 0:c(e,o,a($,1)),n.match(/^:/),r="meta";break;case 1:c(e,o,a($,2)),n.match(T),r="keyword";break;case 2:c(e,o,a($,3)),n.match(/^:/),r="meta";break;case 3:c(e,o,a($,4)),n.match(E);break;default:c(e,o)}else if(k(e)==j||n.match(j,!1))switch(d(e)){case 0:c(e,o,a(j,1)),n.match(X),r="variable-2";break;case 1:c(e,o,a(j,2)),n.match(/^_?_?/)&&(r="link");break;default:c(e,o)}else if(n.match(H))c(e,o),r="quote";else if(n.match(B))c(e,o),r="quote";else if(n.match(G))c(e,o),(!n.peek()||n.peek().match(/^\W$/))&&(r="link");else if(k(e)==g||n.match(g,!1))switch(d(e)){case 0:!n.peek()||n.peek().match(/^\W$/)?c(e,o,a(g,1)):n.match(g);break;case 1:c(e,o,a(g,2)),n.match(/^`/),r="link";break;case 2:c(e,o,a(g,3)),n.match(W);break;case 3:c(e,o,a(g,4)),n.match(/^`_/),r="link";break;default:c(e,o)}else n.match(ee)?c(e,re):n.next()&&c(e,o);return r}function t(n,e){var r=null;if(k(e)==S||n.match(S,!1))switch(d(e)){case 0:c(e,t,a(S,1)),n.match(X),r="variable-2";break;case 1:c(e,t,a(S,2)),n.match(Q);break;case 2:c(e,t,a(S,3)),n.match(U),r="keyword";break;case 3:c(e,t,a(S,4)),n.match(V),r="meta";break;default:c(e,o)}else if(k(e)==A||n.match(A,!1))switch(d(e)){case 0:c(e,t,a(A,1)),n.match(J),r="keyword",n.current().match(/^(?:math|latex)/)?e.tmp_stex=!0:n.current().match(/^python/)&&(e.tmp_py=!0);break;case 1:c(e,t,a(A,2)),n.match(K),r="meta",(n.match(/^latex\s*$/)||e.tmp_stex)&&(e.tmp_stex=void 0,c(e,q,{mode:b,local:l.startState(b)}));break;case 2:c(e,t,a(A,3)),(n.match(/^python\s*$/)||e.tmp_py)&&(e.tmp_py=void 0,c(e,q,{mode:v,local:l.startState(v)}));break;default:c(e,o)}else if(k(e)==O||n.match(O,!1))switch(d(e)){case 0:c(e,t,a(O,1)),n.match(Y),n.match(Z),r="link";break;case 1:c(e,t,a(O,2)),n.match(C),r="meta";break;default:c(e,o)}else n.match(D)||n.match(F)?(c(e,o),r="quote"):(n.eatSpace(),n.eol()?c(e,o):(n.skipToEnd(),c(e,ce),r="comment"));return r}function ce(n,e){return L(n,e,"comment")}function re(n,e){return L(n,e,"meta")}function L(n,e,r){return n.eol()||n.eatSpace()?(n.skipToEnd(),r):(c(e,o),null)}function q(n,e){return e.ctx.mode&&e.ctx.local?n.sol()?(n.eatSpace()||c(e,o),null):e.ctx.mode.token(n,e.ctx.local):(c(e,o),null)}function a(n,e,r,N){return{phase:n,stage:e,mode:r,local:N}}function c(n,e,r){n.tok=e,n.ctx=r||{}}function d(n){return n.ctx.stage||0}function k(n){return n.ctx.phase}return{startState:function(){return{tok:o,ctx:a(void 0,0)}},copyState:function(n){var e=n.ctx,r=n.tmp;return e.local&&(e={mode:e.mode,local:l.copyState(e.mode,e.local)}),r&&(r={mode:r.mode,local:l.copyState(r.mode,r.local)}),{tok:n.tok,ctx:e,tmp:r}},innerMode:function(n){return n.tmp?{state:n.tmp.local,mode:n.tmp.mode}:n.ctx.mode?{state:n.ctx.local,mode:n.ctx.mode}:null},token:function(n,e){return e.tok(n,e)}}},"python","stex"),l.defineMIME("text/x-rst","rst")})})();var ue=M.exports,_e=fe({__proto__:null,default:ue},[M.exports]);export{_e as r};