@directus/app 9.0.0-rc.96 → 9.0.0-rc.97

package/dist/assets/relations.0a568361.js

@@ -0,0 +1,115 @@
+import{r as s,p as i,q as c,w as t,B as e,t as h,P as l}from"./vendor.9bb37c18.js";const d={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=l("What data is linked to what other data. Allows you to assign authors to articles, products to sales, and whatever other structures you can think of. "),g=l("Learn more about Relationships"),f=l("."),m=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-relation-object"},"The Relation Object")]),e("li",null,[e("a",{href:"#list-relations"},"List relations")]),e("li",null,[e("a",{href:"#list-relations-in-collection"},"List relations in collection")]),e("li",null,[e("a",{href:"#retrieve-a-relation"},"Retrieve a relation")]),e("li",null,[e("a",{href:"#create-a-relation"},"Create a Relation")]),e("li",null,[e("a",{href:"#update-a-relation"},"Update a Relation")]),e("li",null,[e("a",{href:"#delete-a-relation"},"Delete a Relation")])])])])],-1),y=e("hr",null,null,-1),j=e("h2",{id:"the-relation-object"},[l("The Relation Object "),e("a",{class:"header-anchor",href:"#the-relation-object"},"#")],-1),b=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",null,"collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the collection. This matches the table name in the database.")]),e("p",null,[e("code",null,"field"),l(),e("strong",null,"string"),e("br"),l(" Name of the field that holds the related primary key. This matches the column name in the database.")]),e("p",null,[e("code",null,"related_collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the related collection. This matches the table name in the database.")])]),e("h4",{id:"meta"},[l("Meta "),e("a",{class:"header-anchor",href:"#meta"},"#")]),e("p",null,"Directus metadata. Used to enable non-database relationship types"),e("div",{class:"definitions"},[e("p",null,[e("code",null,"id"),l(),e("strong",null,"integer"),e("br"),l(" Primary key of the metadata row in "),e("code",null,"directus_relations"),l(".")]),e("p",null,[e("code",null,"many_collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the collection. Matches the top level "),e("code",null,"collection"),l(" field.")]),e("p",null,[e("code",null,"many_field"),l(),e("strong",null,"string"),e("br"),l(" Name of the field. Matches the top level "),e("code",null,"field"),l(" field.")]),e("p",null,[e("code",null,"one_collection"),l(),e("strong",null,"string"),e("br"),l(" Name of the related collection. Matches the top level "),e("code",null,"related_collection"),l(" field.")]),e("p",null,[e("code",null,"one_field"),l(),e("strong",null,"string"),e("br"),l(" Name of the one to many field on the other side of the relation.")]),e("p",null,[e("code",null,"one_allowed_collections"),l(),e("strong",null,"string"),e("br"),l(" What collections are allowed to be used in a many-to-any context.")]),e("p",null,[e("code",null,"one_collection_field"),l(),e("strong",null,"string"),e("br"),l(" Field that holds the collection name in a many-to-any context.")]),e("p",null,[e("code",null,"one_deselect_action"),l(),e("strong",null,"nullify | delete"),e("br"),l(" Whether to nullify or delete related one-to-many records.")]),e("p",null,[e("code",null,"sort_field"),l(),e("strong",null,"string"),e("br"),l(" What field is used to hold the sort field.")]),e("p",null,[e("code",null,"junction_field"),l(),e("strong",null,"string"),e("br"),l(" What field connects two relations in a many-to-many (o2m-m2o) context.")])]),e("h4",{id:"schema"},[l("Schema "),e("a",{class:"header-anchor",href:"#schema"},"#")]),e("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers."),e("div",{class:"definitions"},[e("p",null,[e("code",null,"table"),l(),e("strong",null,"string"),e("br"),l(" The table name.")]),e("p",null,[e("code",null,"column"),l(),e("strong",null,"string"),e("br"),l(" The column name.")]),e("p",null,[e("code",null,"foreign_key_table"),l(),e("strong",null,"string"),e("br"),l(" Related table name.")]),e("p",null,[e("code",null,"foreign_key_column"),l(),e("strong",null,"string"),e("br"),l(" Related column name.")]),e("p",null,[e("code",null,"constraint_name"),l(),e("strong",null,"string"),e("br"),l(" Name for the foreign key constraint.")]),e("p",null,[e("code",null,"on_update"),l(),e("strong",null,"string"),e("br"),l(" Update trigger for the foreign key constraint.")]),e("p",null,[e("code",null,"on_delete"),l(),e("strong",null,"string"),e("br"),l(" Delete trigger for the foreign key constraint.")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[l(`{
+	`),e("span",{class:"hljs-attr"},'"collection"'),l(": "),e("span",{class:"hljs-string"},'"about_us"'),l(`,
+	`),e("span",{class:"hljs-attr"},'"field"'),l(": "),e("span",{class:"hljs-string"},'"logo"'),l(`,
+	`),e("span",{class:"hljs-attr"},'"related_collection"'),l(": "),e("span",{class:"hljs-string"},'"directus_files"'),l(`,
+	`),e("span",{class:"hljs-attr"},'"schema"'),l(`: {
+		`),e("span",{class:"hljs-attr"},'"table"'),l(": "),e("span",{class:"hljs-string"},'"about_us"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"column"'),l(": "),e("span",{class:"hljs-string"},'"logo"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"foreign_key_table"'),l(": "),e("span",{class:"hljs-string"},'"directus_files"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"foreign_key_column"'),l(": "),e("span",{class:"hljs-string"},'"id"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"constraint_name"'),l(": "),e("span",{class:"hljs-string"},'"about_us_logo_foreign"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"on_update"'),l(": "),e("span",{class:"hljs-string"},'"NO ACTION"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"on_delete"'),l(": "),e("span",{class:"hljs-string"},'"SET NULL"'),l(`
+	},
+	`),e("span",{class:"hljs-attr"},'"meta"'),l(`: {
+		`),e("span",{class:"hljs-attr"},'"id"'),l(": "),e("span",{class:"hljs-number"},"1"),l(`,
+		`),e("span",{class:"hljs-attr"},'"junction_field"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"many_collection"'),l(": "),e("span",{class:"hljs-string"},'"about_us"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"many_field"'),l(": "),e("span",{class:"hljs-string"},'"logo"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"one_allowed_collections"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"one_collection"'),l(": "),e("span",{class:"hljs-string"},'"directus_files"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"one_collection_field"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"one_deselect_action"'),l(": "),e("span",{class:"hljs-string"},'"nullify"'),l(`,
+		`),e("span",{class:"hljs-attr"},'"one_field"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`,
+		`),e("span",{class:"hljs-attr"},'"sort_field"'),l(": "),e("span",{class:"hljs-literal"},"null"),l(`
+	}
+}
+`)])])])],-1),q=e("hr",null,null,-1),v=e("h2",{id:"list-relations"},[l("List relations "),e("a",{class:"header-anchor",href:"#list-relations"},"#")],-1),x=e("p",null,"List all relations that exist in Directus.",-1),w=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Permissions"),e("p",null,"The data returned in this endpoint will be filtered based on the user\u2019s permissions. For example, relations that apply to a collection that the current user doesn\u2019t have access to are stripped out.")]),e("h3",{id:"query-parameters"},[l("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")]),e("p",null,"Doesn\u2019t support any query parameters."),e("h3",{id:"returns"},[l("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")]),e("p",null,[l("Array of "),e("a",{href:"#the-relation-object"},"relation objects"),l(". If no items are available, data will be an empty array.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")]),e("pre",null,[e("code",null,`GET /relations
+`)]),e("h3",{id:"graphql"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")]),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"),l(` {
+	relations: [directus_relations]
+}
+`)])]),e("h5",{id:"example"},[l("Example "),e("a",{class:"header-anchor",href:"#example"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
+	relations {
+		collection
+		field
+	}
+}
+`)])])])],-1),T=e("hr",null,null,-1),R=e("h2",{id:"list-relations-in-collection"},[l("List relations in collection "),e("a",{class:"header-anchor",href:"#list-relations-in-collection"},"#")],-1),E=e("p",null,"List all relations that exist in a given collection.",-1),k=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Permissions"),e("p",null,"The data returned in this endpoint will be filtered based on the user\u2019s permissions. For example, relations that apply to a collection that the current user doesn\u2019t have access to are stripped out.")]),e("h3",{id:"query-parameters-2"},[l("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")]),e("p",null,"Doesn\u2019t support any query parameters."),e("h3",{id:"returns-2"},[l("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")]),e("p",null,[l("Array of "),e("a",{href:"#the-relation-object"},"relation objects"),l(". If no items are available, data will be an empty array.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`GET /relations/:collection
+`)]),e("h5",{id:"example-2"},[l("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",null,`GET /relations/articles
+`)]),e("h3",{id:"graphql-2"},[l("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"),l(` {
+	relations_in_collection(collection:`),e("span",{class:"hljs-type"}," String"),l(`!): [directus_relations]
+}
+`)])]),e("h5",{id:"example-3"},[l("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
+	relations_in_collection(collection: `),e("span",{class:"hljs-string"},'"articles"'),l(`) {
+		collection
+		field
+	}
+}
+`)])])])],-1),P=e("hr",null,null,-1),S=e("h2",{id:"retrieve-a-relation"},[l("Retrieve a relation "),e("a",{class:"header-anchor",href:"#retrieve-a-relation"},"#")],-1),L=e("p",null,"List an existing relation by collection/field name.",-1),D=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters-3"},[l("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")]),e("p",null,"Doesn\u2019t support any query parameters."),e("h3",{id:"returns-3"},[l("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")]),e("p",null,[l("Returns the requested "),e("a",{href:"#the-relation-object"},"relation object"),l(".")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`GET /relations/:collection/:field
+`)]),e("h5",{id:"example-4"},[l("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",null,`GET /relations/articles/featured_image
+`)]),e("h3",{id:"graphql-3"},[l("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"}," Query"),l(` {
+	relations_by_name(collection:`),e("span",{class:"hljs-type"}," String"),l("!, field:"),e("span",{class:"hljs-type"}," String"),l(`!): directus_relations
+}
+`)])]),e("h5",{id:"example-5"},[l("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
+	relations_by_name(collection: `),e("span",{class:"hljs-string"},'"articles"'),l(", field: "),e("span",{class:"hljs-string"},'"featured_image"'),l(`) {
+		collection
+		field
+		related_collection
+	}
+}
+`)])])])],-1),A=e("hr",null,null,-1),N=e("h2",{id:"create-a-relation"},[l("Create a Relation "),e("a",{class:"header-anchor",href:"#create-a-relation"},"#")],-1),Q=e("p",null,"Create a new relation.",-1),O=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters-4"},[l("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")]),e("p",null,"Doesn\u2019t support any query parameters."),e("h3",{id:"request-body"},[l("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")]),e("p",null,[l("A partial "),e("a",{href:"#the-relation-object"},"relation object"),l(".")]),e("h3",{id:"returns-4"},[l("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")]),e("p",null,[l("Returns the "),e("a",{href:"#the-relation-object"},"relation object"),l(" for the created relation.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`POST /relations
+`)]),e("h5",{id:"example-6"},[l("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /relations"),l(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"collection"'),l(": "),e("span",{class:"hljs-string"},'"articles"'),l(`,
+	`),e("span",{class:"hljs-attr"},'"field"'),l(": "),e("span",{class:"hljs-string"},'"featured_image"'),l(`,
+	`),e("span",{class:"hljs-attr"},'"related_collection"'),l(": "),e("span",{class:"hljs-string"},'"directus_files"'),l(`
+}
+`)])]),e("h3",{id:"graphql-4"},[l("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"),l(` {
+	create_relations_item(data: create_directus_relations_input!): directus_relations
+}
+`)])]),e("h5",{id:"example-7"},[l("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),l(` {
+	create_relations_item(
+		data: { collection: `),e("span",{class:"hljs-string"},'"articles"'),l(", field: "),e("span",{class:"hljs-string"},'"featured_image"'),l(", related_collection: "),e("span",{class:"hljs-string"},'"directus_files"'),l(` }
+	) {
+		collection
+		field
+		related_collection
+	}
+}
+`)])])])],-1),G=e("hr",null,null,-1),C=e("h2",{id:"update-a-relation"},[l("Update a Relation "),e("a",{class:"header-anchor",href:"#update-a-relation"},"#")],-1),I=e("p",null,"Update an existing relation.",-1),B=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters-5"},[l("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")]),e("p",null,"Doesn\u2019t support any query parameters."),e("h3",{id:"request-body-2"},[l("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")]),e("p",null,[l("A partial "),e("a",{href:"#the-relation-object"},"relation object"),l(".")]),e("h3",{id:"returns-5"},[l("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")]),e("p",null,[l("Returns the "),e("a",{href:"#the-relation-object"},"relation object"),l(" for the created relation.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`PATCH /relations/:collection/:field
+`)]),e("h5",{id:"example-8"},[l("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /relations/articles/author"),l(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"meta"'),l(`: {
+		`),e("span",{class:"hljs-attr"},'"one_field"'),l(": "),e("span",{class:"hljs-string"},'"articles"'),l(`
+	}
+}
+`)])]),e("h3",{id:"graphql-5"},[l("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"),l(` {
+	update_relations_item(collection:`),e("span",{class:"hljs-type"}," String"),l("!, field:"),e("span",{class:"hljs-type"}," String"),l(`!, data: update_directus_relations_input!): directus_relations
+}
+`)])]),e("h5",{id:"example-9"},[l("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),l(` {
+	update_relations_item(collection: `),e("span",{class:"hljs-string"},'"articles"'),l(", field: "),e("span",{class:"hljs-string"},'"author"'),l(", data: { meta: { one_field: "),e("span",{class:"hljs-string"},'"articles"'),l(` } }) {
+		collection
+		field
+		related_collection
+	}
+}
+`)])])])],-1),M=e("hr",null,null,-1),W=e("h2",{id:"delete-a-relation"},[l("Delete a Relation "),e("a",{class:"header-anchor",href:"#delete-a-relation"},"#")],-1),U=e("p",null,"Delete an existing relation.",-1),F=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"returns-6"},[l("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",null,`DELETE /relations/:collection/:field
+`)]),e("h5",{id:"example-10"},[l("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),e("pre",null,[e("code",null,`DELETE /relations/articles/author
+`)]),e("h3",{id:"graphql-6"},[l("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"),l(` {
+	delete_relations_item(collection:`),e("span",{class:"hljs-type"}," String"),l("!, field:"),e("span",{class:"hljs-type"}," String"),l(`!): delete_one
+}
+`)])]),e("h5",{id:"example-11"},[l("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),l(` {
+	delete_relations_item(collection: `),e("span",{class:"hljs-string"},'"articles"'),l(", field: "),e("span",{class:"hljs-string"},'"author"'),l(`) {
+		collection
+		field
+	}
+}
+`)])])])],-1),K={setup(V,{expose:n}){const a={title:"Relations",modularExtension:!1,pageClass:"page-reference"};return n({frontmatter:a}),(H,z)=>{const r=s("router-link"),o=s("DocsWrapper");return i(),c(o,{frontmatter:a},{default:t(()=>[e("div",d,[e("div",p,[e("div",u,[e("blockquote",null,[e("p",null,[_,h(r,{to:"/docs/concepts/relationships/"},{default:t(()=>[g]),_:1}),f])])]),m]),y,j,b,q,v,x,w,T,R,E,k,P,S,L,D,A,N,Q,O,G,C,I,B,M,W,U,F])]),_:1})}}};export{K as default};

package/dist/assets/relationships.7853bd62.js

@@ -0,0 +1,33 @@
+import{r as s,p as r,q as d,w as n,B as e,t as i,P as t}from"./vendor.9bb37c18.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,[t("As you might have guessed, relationships are a crucial part of any relational database. Directus supports all standard relationship types, as well as a few more "),e("em",null,"compound"),t(" types that offer greater flexibility.")])],-1),m=e("p",null,"While it may seem complex at first, relational data is actually quite straightforward once you understand what\u2019s happening behind the confusing terminology. Before diving into the details of each type, let\u2019s first cover a few basics that will help you better visualize each in your mind\u2019s eye.",-1),p=e("h3",{id:"primary-and-foreign-keys"},[t("Primary and Foreign Keys "),e("a",{class:"header-anchor",href:"#primary-and-foreign-keys"},"#")],-1),_=t("Every "),y=t("Item"),f=t(" in a relational database has a unique \u201Ckey\u201D that identifies it within its "),g=t("Collection"),v=t(". Because it\u2019s required, the key is the first "),M=t("field"),b=t(" created within a collection, typically storing an \u201Cauto-increment\u201D number, an automatically generated unique hash, or a manually entered value. They are often abbreviated to \u201CPK\u201D (Primary Key), \u201CID\u201D (Identifier), \u201CUID\u201D (Unique Identifier), or \u201CUUID\u201D (Universally Unique Identifier), depending on the type of value they store. After it\u2019s created, the value of an item\u2019s PK should "),O=e("em",null,"never",-1),w=t(" change."),k=e("p",null,[t("To link items together relationally, you simply save a reference of an item\u2019s PK in a different field. That "),e("em",null,"reference"),t(" is called a Foreign Key (FK).")],-1),K=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Compound Keys"),e("p",null,"To keep things simple, we\u2019ve ignored compound keys in the above explanation.")],-1),x=e("h3",{id:"perspective-matters"},[t("Perspective Matters "),e("a",{class:"header-anchor",href:"#perspective-matters"},"#")],-1),A=e("p",null,"Just like primary and foreign keys are directional, relationships are always relative to their \u201Cparent\u201D collection. Looking at the same relationship/key from the perspective of a different collection may change or reverse its type.",-1),P=e("h2",{id:"many-to-one-(m2o)"},[t("Many-to-One (M2O) "),e("a",{class:"header-anchor",href:"#many-to-one-(m2o)"},"#")],-1),T=e("p",null,[t("A Many-to-One (M2O) relationship exists on a field that saves a single FK. For example, a "),e("em",null,"city"),t(" can only be in one "),e("em",null,"country"),t(", but a "),e("em",null,"country"),t(" can have many "),e("em",null,"cities"),t(". So the M2O data model would look like this:")],-1),C=e("pre",null,[e("code",null,`cities ("Many" Collection)
+- id (PK)
+- name
+- country (M2O that stores the FK to a country)
+
+country ("One" Collection)
+- id (PK, the value saved to "cities.country")
+- name
+`)],-1),q=e("h2",{id:"one-to-many-(o2m)"},[t("One-to-Many (O2M) "),e("a",{class:"header-anchor",href:"#one-to-many-(o2m)"},"#")],-1),F=e("p",null,[t("A One-to-Many (O2M) relationship uses an alias field to reference one or more FKs in a M2O. This is the "),e("em",null,"exact same"),t(" relationship as the M2O above, but looking at it from the opposite perspective (see "),e("a",{href:"#perspective-matters"},"Perspective Matters"),t("). So the O2M data model is the same, but adds an alias \u201Ccities\u201D field to the Country collection, like this:")],-1),I=e("pre",null,[e("code",null,`country ("One" Collection)
+- id (PK, the value saved to "cities.country")
+- name
+- *cities* (O2M alias field that pulls in references from "cities.country")
+
+cities ("Many" Collection)
+- id (PK)
+- name
+- country (stores the FK to a country)
+`)],-1),j=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Manual Reordering"),e("p",null,[t("To enable manual reordering for a O2M, simply add a field with the "),e("code",null,"sort"),t(" type to the \u201Cmany\u201D side ("),e("code",null,"cities"),t(" in the above example).")])],-1),B={class:"tip hint"},D=e("div",{class:"hint-title"},"Translations",-1),S=t("The Translations interface allows "),U=t("creating multilingual content"),R=t(" relationally. It is a standard O2M relationship with an additional field on the \u201Cmany\u201D collection to hold the language key."),J=e("h2",{id:"many-to-many-(m2m)"},[t("Many-to-Many (M2M) "),e("a",{class:"header-anchor",href:"#many-to-many-(m2m)"},"#")],-1),N=e("p",null,[t("A Many-to-Many (M2M) relationship uses a \u201CJunction Table\u201D to connect many items from one collection, to many items of another collection. For example, a "),e("em",null,"recipe"),t(" can have many "),e("em",null,"ingredients"),t(", and "),e("em",null,"ingredients"),t(" can be in many "),e("em",null,"recipes"),t(". So the M2M data model would look like this:")],-1),E=e("pre",null,[e("code",null,`recipes (Collection)
+- id (PK, the value saved to "recipe_ingredients.recipe")
+- name
+- *ingredients* (M2M/O2M alias field that pulls in references from recipe_ingredients)
+
+ingredients (Collection)
+- id (PK, the value saved to "recipe_ingredients.ingredient")
+- name
+- *recipes* (M2M/O2M alias field that pulls in references from recipe_ingredients)
+
+recipe_ingredients (Junction Collection)
+- id (PK)
+- recipe (stores the FK to a recipe)
+- ingredient (stores the FK to a ingredient)
+- quantity
+`)],-1),V=e("p",null,[t("Notice that the example above also has a "),e("code",null,"quantity"),t(" field on the junction table. You can add any contextual fields to the junction, and they will also be included in the App\u2019s relational edit form.")],-1),W=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Actually just two O2Ms"),e("p",null,"An M2M is technically two relationships viewed as one. Each side has a O2M to the Junction Table that sits in the middle. In that sense, there really is no \u201CM2M\u201D.")],-1),Y={class:"tip hint"},H=e("div",{class:"hint-title"},"Manual Reordering",-1),z=t("To enable manual reordering for a M2M, simply add a numeric field to the junction table and set it as the "),L=t("Collection Sort"),G=t("."),Q=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Self-Referencing"),e("p",null,[t("You can also have a M2M relationship that connects items within the "),e("em",null,"same"),t(" collection. As example of this is \u201CRelated Articles\u201D, where an article might relate to many other articles.")])],-1),X=e("h2",{id:"one-to-one-(o2o)"},[t("One-to-One (O2O) "),e("a",{class:"header-anchor",href:"#one-to-one-(o2o)"},"#")],-1),Z=t("Directus does not include a dedicated one-to-one (O2O) relationship type or interface. However, O2O is essentially the same as a M2O (storing a foreign key). The only difference is that a O2O enforces the cardinality. In other words, selecting a relational item in a O2O means that item can not be selected elsewhere (it can only be used once). This functionality can be added by checking and constraining uniqueness via a "),$=t("custom event hook"),ee=t(" or "),te=t("custom interface"),ne=t("."),oe=e("p",null,[t("An example of a O2O is: a "),e("em",null,"person"),t(" only has one unique set of "),e("em",null,"fingerprints"),t(", and those "),e("em",null,"fingerprints"),t(" only belong to one "),e("em",null,"person"),t(".")],-1),ie=e("h2",{id:"many-to-any-(m2a)"},[t("Many-to-Any (M2A) "),e("a",{class:"header-anchor",href:"#many-to-any-(m2a)"},"#")],-1),ae=e("p",null,[t("Sometimes called a \u201Cmatrix field\u201D or \u201Creplicator\u201D, the Many-to-Any (M2A) relationship is essentially the same as a M2M, but with one crucial difference: the junction table also stores the "),e("em",null,"parent collection name of the FK"),t(". This \u201Ccompound key\u201D combines the collection name and FK to provide a unique reference to "),e("em",null,"any"),t(" other item within the project. You can then artificially limit which collections are valid through an \u201Callow list\u201D.")],-1),se=e("p",null,[t("An example of a M2A is a \u201CPage Builder\u201D, which typically have different component Collections such as \u201CHeading\u201D, \u201CText Block\u201D, or \u201CMedia Asset\u201D, and a "),e("em",null,"Pages"),t(" collection on which you can add and arrange them. In this example the junction table will link a specific page with components from a number of different collections, allowing for the creation of relational page layouts.")],-1),he={setup(le,{expose:l}){const a={title:"Relationships",modularExtension:!1};return l({frontmatter:a}),(ce,re)=>{const o=s("router-link"),c=s("DocsWrapper");return r(),d(c,{frontmatter:a},{default:n(()=>[e("div",h,[u,m,p,e("p",null,[_,i(o,{to:"/docs/concepts/items/"},{default:n(()=>[y]),_:1}),f,i(o,{to:"/docs/concepts/collections/"},{default:n(()=>[g]),_:1}),v,i(o,{to:"/docs/concepts/fields/"},{default:n(()=>[M]),_:1}),b,O,w]),k,K,x,A,P,T,C,q,F,I,j,e("div",B,[D,e("p",null,[S,i(o,{to:"/docs/concepts/translations/#content-translations"},{default:n(()=>[U]),_:1}),R])]),J,N,E,V,W,e("div",Y,[H,e("p",null,[z,i(o,{to:"/docs/guides/collections/#sort"},{default:n(()=>[L]),_:1}),G])]),Q,X,e("p",null,[Z,i(o,{to:"/docs/guides/api-hooks"},{default:n(()=>[$]),_:1}),ee,i(o,{to:"/docs/guides/interfaces"},{default:n(()=>[te]),_:1}),ne]),oe,ie,ae,se])]),_:1})}}};export{he as default};

package/dist/assets/revisions.4cd101b7.js

@@ -0,0 +1 @@
+import{r as i,p as c,q as d,w as s,B as e,t as a,P as t}from"./vendor.9bb37c18.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,[t("Revisions are created when an "),e("em",null,"original"),t(" Item is updated. These alternate versions are tracked so that previous states can be recovered, or potential edits can be staged.")])],-1),_=t("Every change made to items in Directus is stored as a complete versioned snapshot. The Revisions system is tightly coupled to the Activity Logs system, with each revision being linked to the specific "),p=t("Activity"),v=t(" event which created it."),m=e("h2",{id:"revision-fields"},[t("Revision Fields "),e("a",{class:"header-anchor",href:"#revision-fields"},"#")],-1),f=e("ul",null,[e("li",null,[e("strong",null,"Data"),t(" \u2014 A full snapshot of the item "),e("em",null,"after"),t(" the event")]),e("li",null,[e("strong",null,"Delta"),t(" \u2014 The specific field data changed by this event")]),e("li",null,[e("strong",null,"Parent"),t(" \u2014 If this revision was created via a nested relationship")])],-1),g=e("h4",{id:"relevant-guides"},[t("Relevant Guides "),e("a",{class:"header-anchor",href:"#relevant-guides"},"#")],-1),y=t("Reverting an Item"),x={setup(b,{expose:l}){const o={title:"Revisions & Versioning",modularExtension:!1};return l({frontmatter:o}),(k,w)=>{const n=i("router-link"),r=i("DocsWrapper");return c(),d(r,{frontmatter:o},{default:s(()=>[e("div",h,[u,e("p",null,[_,a(n,{to:"/docs/concepts/application/#activity-log"},{default:s(()=>[p]),_:1}),v]),m,f,g,e("ul",null,[e("li",null,[a(n,{to:"/docs/guides/items/#reverting-an-item"},{default:s(()=>[y]),_:1})])])])]),_:1})}}};export{x as default};

package/dist/assets/revisions.fd9d7b28.js

@@ -0,0 +1,40 @@
+import{r as l,p as c,q as h,w as t,B as s,t as o,P as e}from"./vendor.9bb37c18.js";const d={class:"markdown-body"},_={class:"two-up"},p={class:"left"},u=e("Revisions are individual changes to items made. Directus keeps track of changes made, so you\u2019re able to revert to a previous state at will. "),v=e("Learn more about Revisions"),m=e("."),f=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-revision-object"},"The Revision Object")]),s("li",null,[s("a",{href:"#list-revisions"},"List revisions")]),s("li",null,[s("a",{href:"#retrieve-a-revision"},"Retrieve a revision")])])])])],-1),y=s("hr",null,null,-1),g=s("h2",{id:"the-revision-object"},[e("The Revision Object "),s("a",{class:"header-anchor",href:"#the-revision-object"},"#")],-1),b={class:"two-up"},j={class:"left"},q={class:"definitions"},x=s("p",null,[s("code",null,"id"),e(),s("strong",null,"integer"),s("br"),e(" Primary key of the revision.")],-1),w=s("code",null,"activity",-1),k=e(),R=s("strong",null,"many-to-one",-1),E=s("br",null,null,-1),P=e(" Related activity record. Many-to-one to "),T=e("activity"),S=e("."),L=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" Collection in which this revision happened.")],-1),C=s("p",null,[s("code",null,"item"),e(),s("strong",null,"string"),s("br"),e(" Primary key of the item that was changed.")],-1),D=s("p",null,[s("code",null,"data"),e(),s("strong",null,"object"),s("br"),e(" Snapshot of the top-level item data.")],-1),Q=s("p",null,[s("code",null,"delta"),e(),s("strong",null,"object"),s("br"),e(" Snapshot of the changes made in this revision.")],-1),A=s("p",null,[s("code",null,"parent"),e(),s("strong",null,"many-to-one"),s("br"),e(" Parent revision that triggered this revision. Many-to-one to revisions (recursive).")],-1),G=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
+	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-number"},"368"),e(`,
+	`),s("span",{class:"hljs-attr"},'"activity"'),e(": "),s("span",{class:"hljs-number"},"438"),e(`,
+	`),s("span",{class:"hljs-attr"},'"collection"'),e(": "),s("span",{class:"hljs-string"},'"articles"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"item"'),e(": "),s("span",{class:"hljs-string"},'"1"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
+		`),s("span",{class:"hljs-attr"},'"title"'),e(": "),s("span",{class:"hljs-string"},'"Hello World"'),e(`
+	},
+	`),s("span",{class:"hljs-attr"},'"delta"'),e(`: {
+		`),s("span",{class:"hljs-attr"},'"title"'),e(": "),s("span",{class:"hljs-string"},'"Hello from the Docs!"'),e(`
+	},
+	`),s("span",{class:"hljs-attr"},'"parent"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`
+}
+`)])])],-1),B=s("hr",null,null,-1),H=s("h2",{id:"list-revisions"},[e("List revisions "),s("a",{class:"header-anchor",href:"#list-revisions"},"#")],-1),I=s("p",null,"List all revisions that exist in Directus.",-1),O={class:"two-up"},N={class:"left"},V=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"The data returned in this endpoint will be filtered based on the user\u2019s permissions. For example, revisions that apply to a collection that the current user doesn\u2019t have access to are stripped out.")],-1),W=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),M=e("Supports all "),F=e("global query parameters"),z=e("."),J=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),K=e("An array of up to "),U=e("limit"),X=e(),Y=s("a",{href:"#the-revision-object"},"revision objects",-1),Z=e(". If no items are available, data will be an empty array."),$={class:"right"},ss=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),es=s("pre",null,[s("code",null,`GET /revisions
+SEARCH /revisions
+`)],-1),ts=e("Learn more about SEARCH ->"),ns=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),os=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),as=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	revisions: [directus_revisions]
+}
+`)])],-1),ls=s("h5",{id:"examples"},[e("Examples "),s("a",{class:"header-anchor",href:"#examples"},"#")],-1),is=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	revisions {
+		id
+		data
+		delta
+	}
+}
+`)])],-1),rs=s("hr",null,null,-1),cs=s("h2",{id:"retrieve-a-revision"},[e("Retrieve a revision "),s("a",{class:"header-anchor",href:"#retrieve-a-revision"},"#")],-1),hs=s("p",null,"List an existing revision by primary key.",-1),ds={class:"two-up"},_s={class:"left"},ps=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),us=e("Supports all "),vs=e("global query parameters"),ms=e("."),fs=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ys=s("p",null,[e("Returns the requested "),s("a",{href:"#the-revision-object"},"revision object"),e(".")],-1),gs=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 /revisions/:id
+`)]),s("h5",{id:"example"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")]),s("pre",null,[s("code",null,`GET /revisions/322
+`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),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(` {
+	revisions_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_revisions
+}
+`)])]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	revisions_by_id(id: `),s("span",{class:"hljs-number"},"322"),e(`) {
+		id
+		data
+		delta
+	}
+}
+`)])])],-1),ws={setup(bs,{expose:i}){const a={title:"Revisions",modularExtension:!1,pageClass:"page-reference"};return i({frontmatter:a}),(js,qs)=>{const n=l("router-link"),r=l("DocsWrapper");return c(),h(r,{frontmatter:a},{default:t(()=>[s("div",d,[s("div",_,[s("div",p,[s("blockquote",null,[s("p",null,[u,o(n,{to:"/docs/concepts/revisions/"},{default:t(()=>[v]),_:1}),m])])]),f]),y,g,s("div",b,[s("div",j,[s("div",q,[x,s("p",null,[w,k,R,E,P,o(n,{to:"/docs/reference/api/system/activity/"},{default:t(()=>[T]),_:1}),S]),L,C,D,Q,A])]),G]),B,H,I,s("div",O,[s("div",N,[V,W,s("p",null,[M,o(n,{to:"/docs/reference/api/query"},{default:t(()=>[F]),_:1}),z]),J,s("p",null,[K,o(n,{to:"/docs/reference/api/query/#limit"},{default:t(()=>[U]),_:1}),X,Y,Z])]),s("div",$,[ss,es,s("p",null,[o(n,{to:"/docs/reference/api/introduction/#search-http-method"},{default:t(()=>[ts]),_:1})]),ns,os,as,ls,is])]),rs,cs,hs,s("div",ds,[s("div",_s,[ps,s("p",null,[us,o(n,{to:"/docs/reference/api/query"},{default:t(()=>[vs]),_:1}),ms]),fs,ys]),gs])])]),_:1})}}};export{ws as default};

package/dist/assets/ro-RO.ccadca2e.js

@@ -0,0 +1 @@
+var e={avatar:"Avatar",edit_field:"Editeaz\u0103 c\xE2mp",item_revision:"Revizuire element",duplicate_field:"Duplicare c\xE2mp",half_width:"Jum\u0103tate de l\u0103\u0163ime",full_width:"L\u0103\u0163ime total\u0103",fill_width:"Umple l\u0103\u0163ime",field_name_translations:"Traducerile numelui c\xE2mpului",enter_password_to_enable_tfa:"Introduce\u021Bi parola pentru a activa autentificarea \xEEn doi pa\u015Fi",add_field:"Adaug\u0103 c\xE2mp",role_name:"Nume de rol",db_only_click_to_configure:"Doar baza de date: Ap\u0103sa\u0163i pentru a configura ",show_archived_items:"Arat\u0103 elementele arhivate",required:"Necesar",requires_value:"Necesit\u0103 valoare",create_preset:"Creeaz\u0103 presetare",create_role:"Creeaz\u0103 Rol",create_user:"Creeaz\u0103 utilizator",create_webhook:"Creeaz\u0103 Webhook",invite_users:"Invit\u0103 utilizatori",invite:"Invit\u0103",emails:"E-mailuri",connection_excellent:"Conexiune excelent\u0103",connection_good:"Conexiune bun\u0103",connection_fair:"Conexiune rezonabil\u0103",connection_poor:"Conexiune slab\u0103",rename_folder:"Redenume\u015Fte folderul",delete_folder:"\u015Eterge folderul",reset_bookmark:"Reseteaz\u0103 semnul de carte",rename_bookmark:"Redenume\u015Fte semnul de carte",update_bookmark:"Actualizeaz\u0103 semnul de carte",delete_bookmark:"\u0218terge semn de carte",delete_bookmark_copy:'Sunte\u0163i sigur c\u0103 dori\u0163i s\u0103 \u015Fterge\u0163i semnul de carte "{bookmark}"? Aceast\u0103 ac\u0163iune nu poate fi modificat\u0103 ulterior.',logoutReason:{SIGN_OUT:"Deconectat",SESSION_EXPIRED:"Sesiunea a expirat"},public_description:"Controleaz\u0103 ce date API sunt disponibile f\u0103r\u0103 autentificare.",not_allowed:"Nu este permis",directus_version:"Versiune Directus",node_version:"Versiune Node",node_uptime:"Timp de activitate Node",os_type:"Tipul SO",os_version:"Versiunea SO",os_uptime:"Timpul de activitate al SO",os_totalmem:"Memoria SO",archive:"Arhiveaz\u0103",archive_confirm:"Sunte\u0163i sigur c\u0103 dori\u0163i s\u0103 arhiva\u0163i acest element?",archive_confirm_count:"Niciun element selectat | Sunte\u0163i sigur c\u0103 dori\u0163i s\u0103 arhiva\u0163i acest element? | Sunte\u0163i sigur c\u0103 dori\u0163i s\u0103 arhiva\u0163i aceste {count} elemente?",unarchive:"Dezarhivare",unarchive_confirm:"Sunte\u0163i sigur c\u0103 dori\u0163i s\u0103 dezarhiva\u0163i acest element?",nested_files_folders_will_be_moved:"Fi\u015Fierele \u015Fi folderele suprapuse vor fi mutate cu un nivel mai sus.",create_field:"Creeaz\u0103 C\xE2mp",auto_generate:"Generare automat\u0103",add_note:"Adaug\u0103 o not\u0103 ajut\u0103toare pentru utilizatori...",default_value:"Valoare implicit\u0103",clear_value:"\u0218terge valoarea",title:"Titlu",checksum:"Sum\u0103 de control",owner:"Proprietar",download:"Desc\u0103rca\u021Bi",created_by:"Creat De",created_on:"Creat Pe",comments:"Comentarii",create_collection:"Creeaz\u0103 Colec\u021Bie",users:"Utilizatori",activity:"Activitate",action:"Ac\u0163iune",ip_address:"Adres\u0103 IP",user_agent:"User Agent",duration:"Durat\u0103",status:"Stare",bookmarks:"Semne de carte",back:"\xCEnapoi",operators:{gt:"Mai mare ca",gte:"Mai mare sau egal cu",contains:"Con\u021Bine"},role:"Rol",create:"Creeaz\u0103",width:"L\u0103\u021Bime",height:"\xCEn\u0103l\u0163ime",wysiwyg_options:{table:"Tabel"},choices:"Op\u021Biuni",deselect:"Deselecta\u0163i",editing_in_batch:"Editare lot de {count} elemente",discard_changes:"Renun\u021B\u0103 la modific\u0103ri",add_new:"Adaugare intrare nou\u0103",all:"Tot",batch_delete_confirm:"Nu au fost selectate articole | Sigur dori\u021Bi s\u0103 \u0219terge\u021Bi acest articol? Aceast\u0103 ac\u021Biune nu poate fi anulat\u0103. | Sigur dori\u021Bi s\u0103 \u0219terge\u021Bi aceste {count} elemente? Aceast\u0103 ac\u021Biune nu poate fi anulat\u0103.",cancel:"Anuleaz\u0103",collection:"Colec\u021Bie",collections:"Colec\u021Bii",fields:{directus_activity:{item:"Cheia primar\u0103 a elementului",action:"Ac\u0163iune",collection:"Colec\u021Bie",timestamp:"Ac\u021Biune pe",user:"Ac\u021Biune de",comment:"Comentariu",user_agent:"User Agent",ip:"Adres\u0103 IP"},directus_collections:{collection:"Colec\u021Bie",icon:"Iconi\u021B\u0103",hidden:"Ascuns"},directus_files:{title:"Titlu",description:"Descriere",tags:"Etichete",location:"Loca\u021Bie",metadata:"Metadate",filesize:"Dimensiune fi\u015Fier",created_on:"Creat Pe",created_by:"Creat De",embed:"\xCEncorpora\u021Bi",uploaded_by:"\xCEnc\u0103rcat de",width:"L\u0103\u021Bime",uploaded_on:"\xCEnc\u0103rcat pe",height:"\xCEn\u0103l\u0163ime",duration:"Durat\u0103"},directus_users:{first_name:"Prenume",last_name:"Nume",email:"Email",password:"Parol\u0103",avatar:"Avatar",location:"Loca\u021Bie",title:"Titlu",description:"Descriere",tags:"Etichete",theme:"Tem\u0103",tfa_secret:"Autentificare \xEEn doi pa\u0219i",status:"Stare",role:"Rol"},directus_fields:{hidden:"Ascuns",translation:"Traducerile numelui c\xE2mpului"},directus_roles:{name:"Nume de rol",description:"Descriere"},directus_webhooks:{status:"Stare"}},field_options:{directus_activity:{create:"Creeaz\u0103"},directus_collections:{archive_divider:"Arhiveaz\u0103"},directus_roles:{fields:{icon_name:"Iconi\u021B\u0103"},collections_name:"Colec\u021Bii"},directus_webhooks:{actions_create:"Creeaz\u0103"}},comment:"Comentariu",delete_field_are_you_sure:'Sunte\u0163i sigur c\u0103 dori\u0163i s\u0103 \u015Fterge\u0163i c\xE2mpul "{field}"? Aceast\u0103 ac\u0163iune nu poate fi modificat\u0103 ulterior.',description:"Descriere",done:"Efectuat",duplicate:"Duplicare",email:"Email",embed:"\xCEncorpora\u021Bi",field:"C\xE2mp | C\xE2mpuri",hidden:"Ascuns",icon:"Iconi\u021B\u0103",info:"Info",password:"Parol\u0103",interfaces:{filter:{all:"Tot"},"system-collection":{collection:"Colec\u021Bie"},"system-collections":{collections:"Colec\u021Bii"},files:{files:"Fi\u015Fiere"},"select-icon":{icon:"Iconi\u021B\u0103"},tags:{tags:"Etichete"}},displays:{collection:{collection:"Colec\u021Bie"},icon:{icon:"Iconi\u021B\u0103"},user:{avatar:"Avatar",both:"Ambele"}},layouts:{cards:{cards:"Carduri",image_source:"Sursa Imaginii",title:"Titlu",subtitle:"Subtitlu"},tabular:{tabular:"Tabel",comfortable:"Confortabil",compact:"Compact",cozy:"Comod"}}},a=e.avatar,i=e.edit_field,r=e.item_revision,t=e.duplicate_field,o=e.half_width,c=e.full_width,n=e.fill_width,l=e.field_name_translations,s=e.enter_password_to_enable_tfa,d=e.add_field,_=e.role_name,u=e.db_only_click_to_configure,v=e.show_archived_items,m=e.required,f=e.requires_value,p=e.create_preset,h=e.create_role,b=e.create_user,g=e.create_webhook,k=e.invite_users,w=e.invite,C=e.emails,y=e.connection_excellent,A=e.connection_good,z=e.connection_fair,S=e.connection_poor,D=e.rename_folder,I=e.delete_folder,T=e.reset_bookmark,E=e.rename_bookmark,N=e.update_bookmark,R=e.delete_bookmark,x=e.delete_bookmark_copy,P=e.logoutReason,O=e.public_description,q=e.not_allowed,L=e.directus_version,U=e.node_version,M=e.node_uptime,V=e.os_type,F=e.os_version,G=e.os_uptime,j=e.os_totalmem,J=e.archive,W=e.archive_confirm,X=e.archive_confirm_count,B=e.unarchive,H=e.unarchive_confirm,K=e.nested_files_folders_will_be_moved,Q=e.create_field,Y=e.auto_generate,Z=e.add_note,$=e.default_value,ee=e.clear_value,ae=e.title,ie=e.checksum,re=e.owner,te=e.download,oe=e.created_by,ce=e.created_on,ne=e.comments,le=e.create_collection,se=e.users,de=e.activity,_e=e.action,ue=e.ip_address,ve=e.user_agent,me=e.duration,fe=e.status,pe=e.bookmarks,he=e.back,be=e.operators,ge=e.role,ke=e.create,we=e.width,Ce=e.height,ye=e.wysiwyg_options,Ae=e.choices,ze=e.deselect,Se=e.editing_in_batch,De=e.discard_changes,Ie=e.add_new,Te=e.all,Ee=e.batch_delete_confirm,Ne=e.cancel,Re=e.collection,xe=e.collections,Pe=e.fields,Oe=e.field_options,qe=e.comment,Le=e.delete_field_are_you_sure,Ue=e.description,Me=e.done,Ve=e.duplicate,Fe=e.email,Ge=e.embed,je=e.field,Je=e.hidden,We=e.icon,Xe=e.info,Be=e.password,He=e.interfaces,Ke=e.displays,Qe=e.layouts;export{_e as action,de as activity,d as add_field,Ie as add_new,Z as add_note,Te as all,J as archive,W as archive_confirm,X as archive_confirm_count,Y as auto_generate,a as avatar,he as back,Ee as batch_delete_confirm,pe as bookmarks,Ne as cancel,ie as checksum,Ae as choices,ee as clear_value,Re as collection,xe as collections,qe as comment,ne as comments,y as connection_excellent,z as connection_fair,A as connection_good,S as connection_poor,ke as create,le as create_collection,Q as create_field,p as create_preset,h as create_role,b as create_user,g as create_webhook,oe as created_by,ce as created_on,u as db_only_click_to_configure,e as default,$ as default_value,R as delete_bookmark,x as delete_bookmark_copy,Le as delete_field_are_you_sure,I as delete_folder,Ue as description,ze as deselect,L as directus_version,De as discard_changes,Ke as displays,Me as done,te as download,Ve as duplicate,t as duplicate_field,me as duration,i as edit_field,Se as editing_in_batch,Fe as email,C as emails,Ge as embed,s as enter_password_to_enable_tfa,je as field,l as field_name_translations,Oe as field_options,Pe as fields,n as fill_width,c as full_width,o as half_width,Ce as height,Je as hidden,We as icon,Xe as info,He as interfaces,w as invite,k as invite_users,ue as ip_address,r as item_revision,Qe as layouts,P as logoutReason,K as nested_files_folders_will_be_moved,M as node_uptime,U as node_version,q as not_allowed,be as operators,j as os_totalmem,V as os_type,G as os_uptime,F as os_version,re as owner,Be as password,O as public_description,E as rename_bookmark,D as rename_folder,m as required,f as requires_value,T as reset_bookmark,ge as role,_ as role_name,v as show_archived_items,fe as status,ae as title,B as unarchive,H as unarchive_confirm,N as update_bookmark,ve as user_agent,se as users,we as width,ye as wysiwyg_options};

package/dist/assets/roles.516dcfd0.js

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

package/dist/assets/roles.67f9d19e.js

@@ -0,0 +1 @@
+import{r as a,p as c,q as d,w as o,B as e,t as i,P as s}from"./vendor.9bb37c18.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"Roles define a specific set of access permissions, and are the primary organizational structure for Users within the platform.")],-1),_=s("Each User is assigned a single Role which determines their "),p=s("Permissions"),m=s(" within the App and API. Roles also include options for configuring platform access, Two-Factor Auth, Module Navigation, and Collection Navigation. You can create an unlimited number of roles, so organize your users in whatever way feels most appropriate."),f=e("p",null,[s("Two default roles, "),e("em",null,"Public"),s(" and "),e("em",null,"Administrators"),s(", are available after installing a clean copy of Directus.")],-1),g=e("h4",{id:"relevant-guides"},[s("Relevant Guides "),e("a",{class:"header-anchor",href:"#relevant-guides"},"#")],-1),b=s("Creating a Role"),v=s("Configuring a Role"),w=s("Configuring Role Permissions"),y=s("Configuring System Permissions"),R=s("Deleting a Role"),P=e("h3",{id:"public-role"},[s("Public Role "),e("a",{class:"header-anchor",href:"#public-role"},"#")],-1),A=e("p",null,[s("Not technically a role, \u201CPublic\u201D can\u2019t be found in the "),e("code",null,"directus_roles"),s(" table. Instead, it represents the "),e("em",null,"lack"),s(" of a role, providing a place to configure permissions for "),e("em",null,"unauthenticated"),s(" users. This role can not be deleted.")],-1),D=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Private by Default"),e("p",null,"All of the data within Directus is private by default. Permissions within the public role can be added by administrators on a case-by-case basis.")],-1),k=e("h3",{id:"administrators-role"},[s("Administrators Role "),e("a",{class:"header-anchor",href:"#administrators-role"},"#")],-1),C=e("p",null,[s("During the installation process, Directus automatically creates an \u201CAdministrators\u201D Role, which is used to provide the initial admin user with full platform access. However this is just a "),e("em",null,"normal"),s(" role, and so it can still be updated, renamed, or even deleted. Keep in mind that your project must maintain at least one role with Admin Access at all times.")],-1),j={setup(N,{expose:l}){const n={title:"Roles",modularExtension:!1};return l({frontmatter:n}),(x,B)=>{const t=a("router-link"),r=a("DocsWrapper");return c(),d(r,{frontmatter:n},{default:o(()=>[e("div",u,[h,e("p",null,[_,i(t,{to:"/docs/concepts/permissions/"},{default:o(()=>[p]),_:1}),m]),f,g,e("ul",null,[e("li",null,[i(t,{to:"/docs/guides/roles/#creating-a-role"},{default:o(()=>[b]),_:1})]),e("li",null,[i(t,{to:"/docs/guides/roles/#configuring-a-role"},{default:o(()=>[v]),_:1})]),e("li",null,[i(t,{to:"/docs/guides/permissions/#configuring-role-permissions"},{default:o(()=>[w]),_:1})]),e("li",null,[i(t,{to:"/docs/guides/permissions/#configuring-system-permissions"},{default:o(()=>[y]),_:1})]),e("li",null,[i(t,{to:"/docs/guides/roles/#deleting-a-role"},{default:o(()=>[R]),_:1})])]),P,A,D,k,C])]),_:1})}}};export{j as default};

package/dist/assets/roles.7a89c5c2.js

@@ -0,0 +1,23 @@
+import{r as i,p as c,q as u,w as e,B as l,t as s,P as t}from"./vendor.9bb37c18.js";const h={class:"markdown-body"},d=t("Roles define a specific set of access permissions, and are the primary organizational structure for Users within the platform. "),g=t("Learn more about Roles"),p=t("."),m=l("h2",{id:"creating-a-role"},[t("Creating a Role "),l("a",{class:"header-anchor",href:"#creating-a-role"},"#")],-1),_=l("ol",null,[l("li",null,[t("Navigate to "),l("strong",null,"Settings > Roles & Permissions")]),l("li",null,[t("Click the "),l("strong",null,"Create Role"),t(" action button in the header")]),l("li",null,[t("Enter a unique "),l("strong",null,"Role Name")]),l("li",null,[t("Enabling "),l("strong",null,"App Access"),t(" allows logging in to the App")]),l("li",null,[t("Enabling "),l("strong",null,"Admin Access"),t(" gives full permission to project data and Settings")])],-1),f=l("h2",{id:"configuring-a-role"},[t("Configuring a Role "),l("a",{class:"header-anchor",href:"#configuring-a-role"},"#")],-1),v=l("ul",null,[l("li",null,[l("strong",null,"Permissions"),t(" \u2014 Defines the role\u2019s access permissions")]),l("li",null,[l("strong",null,"Role Name"),t(" \u2014 This is the name of the role")]),l("li",null,[l("strong",null,"Role Icon"),t(" \u2014 The icon used throughout the App when referencing this role")]),l("li",null,[l("strong",null,"Description"),t(" \u2014 A helpful note that explains the role\u2019s purpose")]),l("li",null,[l("strong",null,"App Access"),t(" \u2014 Allows logging in to the App")]),l("li",null,[l("strong",null,"Admin Access"),t(" \u2014 Gives full permission to project data and Settings")]),l("li",null,[l("strong",null,"IP Access"),t(" \u2014 An allow-list of IP addresses from which the platform can be accessed, empty allows all")]),l("li",null,[l("strong",null,"Require 2FA"),t(" \u2014 Forces all users within this role to use two-factor authentication")]),l("li",null,[l("strong",null,"Users in Role"),t(" \u2014 A list of all users within this role")]),l("li",null,[l("strong",null,"Module Navigation"),t(" \u2014 Overrides the visible modules")]),l("li",null,[l("strong",null,"Collection Navigation"),t(" \u2014 Overrides the collection module\u2019s navigation")])],-1),b=l("h3",{id:"customizing-the-module-navigation"},[t("Customizing the Module Navigation "),l("a",{class:"header-anchor",href:"#customizing-the-module-navigation"},"#")],-1),w=t("The options in the "),j=t("Module Bar"),A=t(" can be overridden with custom options per role. When this setting is empty, the default modules are used."),C=l("ol",null,[l("li",null,[t("Navigate to "),l("strong",null,"Settings > Roles & Permissions > [Role Name]")]),l("li",null,[t("Scroll to the "),l("strong",null,"Module Navigation"),t(" field")]),l("li",null,[t("Click the "),l("strong",null,"Add a new item"),t(" button to add a module")]),l("li",null,[t("Choose an "),l("strong",null,"Icon"),t(" to display for the module")]),l("li",null,[t("Choose a "),l("strong",null,"Name"),t(" for the module")]),l("li",null,[t("Enter a relative (App) or absolute (external) "),l("strong",null,"link"),t(" for the module")]),l("li",null,[t("Use the drag handles to "),l("strong",null,"drag-and-drop"),t(" the modules into the desired order")])],-1),y=l("p",null,"If you are looking to replicate the default modules, paste the following configuration into the Module Navigation field using the Raw Value field label option.",-1),N=l("pre",null,[l("code",{class:"language-json"},[t(`[
+	{
+		`),l("span",{class:"hljs-attr"},'"icon"'),t(": "),l("span",{class:"hljs-string"},'"box"'),t(`,
+		`),l("span",{class:"hljs-attr"},'"name"'),t(": "),l("span",{class:"hljs-string"},'"Collections"'),t(`,
+		`),l("span",{class:"hljs-attr"},'"link"'),t(": "),l("span",{class:"hljs-string"},'"/collections"'),t(`
+	},
+	{
+		`),l("span",{class:"hljs-attr"},'"icon"'),t(": "),l("span",{class:"hljs-string"},'"people_alt"'),t(`,
+		`),l("span",{class:"hljs-attr"},'"name"'),t(": "),l("span",{class:"hljs-string"},'"User Directory"'),t(`,
+		`),l("span",{class:"hljs-attr"},'"link"'),t(": "),l("span",{class:"hljs-string"},'"/users"'),t(`
+	},
+	{
+		`),l("span",{class:"hljs-attr"},'"icon"'),t(": "),l("span",{class:"hljs-string"},'"folder"'),t(`,
+		`),l("span",{class:"hljs-attr"},'"name"'),t(": "),l("span",{class:"hljs-string"},'"File Library"'),t(`,
+		`),l("span",{class:"hljs-attr"},'"link"'),t(": "),l("span",{class:"hljs-string"},'"/files"'),t(`
+	},
+	{
+		`),l("span",{class:"hljs-attr"},'"icon"'),t(": "),l("span",{class:"hljs-string"},'"info"'),t(`,
+		`),l("span",{class:"hljs-attr"},'"name"'),t(": "),l("span",{class:"hljs-string"},'"Documentation"'),t(`,
+		`),l("span",{class:"hljs-attr"},'"link"'),t(": "),l("span",{class:"hljs-string"},'"/docs"'),t(`
+	}
+]
+`)])],-1),R=l("div",{class:"warning hint"},[l("div",{class:"hint-title"},"Settings Module"),l("p",null,"The settings module is not controlled by this configuration. It is always added to the end of the list for any user\u2019s with Admin Access.")],-1),k=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Customizing Existing Modules"),l("p",null,[t("You can enter the link to an existing module to customize its name or icon. For example, you can use "),l("code",null,"/collections"),t(" to override the Collections module.")])],-1),P=l("h3",{id:"customizing-the-collection-navigation"},[t("Customizing the Collection Navigation "),l("a",{class:"header-anchor",href:"#customizing-the-collection-navigation"},"#")],-1),x=t("The collections in the "),D=t("Navigation Bar"),S=t(" can be overridden with custom options per role. When this setting is empty, all collections that the user has permission to see are shown alphabetically in a single, unlabeled group."),z=l("ol",null,[l("li",null,[t("Navigate to "),l("strong",null,"Settings > Roles & Permissions > [Role Name]")]),l("li",null,[t("Scroll to the "),l("strong",null,"Collection Navigation"),t(" field")]),l("li",null,[t("Click the "),l("strong",null,"Add New Group"),t(" button to add a Grouping")]),l("li",null,[t("Enter a "),l("strong",null,"Group Name"),t(", or leave it empty to simply show a divider")]),l("li",null,[t("Choose if the group\u2019s "),l("strong",null,"Accordion"),t(" will be\u2026 "),l("ul",null,[l("li",null,"Always Open (Default)"),l("li",null,"Start Open"),l("li",null,"Start Collapsed")])]),l("li",null,[t("Click the "),l("strong",null,"Add New Collection"),t(" button to add a Collection")]),l("li",null,[t("Choose a "),l("strong",null,"Collection"),t(" from the dropdown")]),l("li",null,[t("Use the drag handles to "),l("strong",null,"drag-and-drop"),t(" the groups/collections into the desired order")])],-1),T=l("h2",{id:"deleting-a-role"},[t("Deleting a Role "),l("a",{class:"header-anchor",href:"#deleting-a-role"},"#")],-1),E=l("ol",null,[l("li",null,[t("Navigate to "),l("strong",null,"Settings > Roles & Permissions > [Role Name]")]),l("li",null,[t("Click the red "),l("strong",null,"Delete Role"),t(" action button in the header")]),l("li",null,[t("Confirm this decision by clicking "),l("strong",null,"Delete"),t(" in the dialog")])],-1),I={class:"warning hint"},M=l("div",{class:"hint-title"},"Users in a Deleted Role",-1),U=t("If you delete a role that still has users in it, those users will be given a "),B=l("code",null,"NULL",-1),L=t(" role, which denies their App access and limits them to the "),q=t("Public Role"),F=t(" permissions. They can then be reassigned to a new role by an admin."),G=l("div",{class:"warning hint"},[l("div",{class:"hint-title"},"Last Admin"),l("p",null,"You must maintain at least one role/user with Admin Access so that you can still properly manage the project.")],-1),O=l("div",{class:"warning hint"},[l("div",{class:"hint-title"},"Public Role"),l("p",null,"You can not delete the Public role, as it is part of the core platform. To disable it completely, simply turn off all Public access permissions.")],-1),J={setup(V,{expose:a}){const o={title:"Roles",modularExtension:!1};return a({frontmatter:o}),(W,Y)=>{const n=i("router-link"),r=i("DocsWrapper");return c(),u(r,{frontmatter:o},{default:e(()=>[l("div",h,[l("blockquote",null,[l("p",null,[d,s(n,{to:"/docs/concepts/roles/"},{default:e(()=>[g]),_:1}),p])]),m,_,f,v,b,l("p",null,[w,s(n,{to:"/docs/concepts/application/#_1-module-bar"},{default:e(()=>[j]),_:1}),A]),C,y,N,R,k,P,l("p",null,[x,s(n,{to:"/docs/concepts/application/#_2-navigation-bar"},{default:e(()=>[D]),_:1}),S]),z,T,E,l("div",I,[M,l("p",null,[U,B,L,s(n,{to:"/docs/concepts/roles/#public-role"},{default:e(()=>[q]),_:1}),F])]),G,O])]),_:1})}}};export{J as default};

package/dist/assets/rpm.f26b7980.js

@@ -0,0 +1 @@
+import{bz as d}from"./vendor.9bb37c18.js";function m(i,f){return f.forEach(function(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(i)}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=Object.freeze(m({__proto__:null,[Symbol.toStringTag]:"Module",default:g},[p.exports]));export{v as r};