@directus/app 9.22.1 → 9.22.2

package/dist/assets/roles-027aa7ac.js

@@ -0,0 +1,171 @@
+import{a as c,o as h,e as r,y as n,u as s,q as a,z as t}from"./runtime-core.esm-bundler-753bcc58.js";const u={class:"markdown-body"},i=s("hr",null,null,-1),d=s("h2",{id:"the-role-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-role-object"},"#"),a(" The Role Object")],-1),j=s("p",null,[s("code",null,"id"),a(),s("strong",null,"uuid"),s("br"),a(" Primary key of the role.")],-1),_=s("p",null,[s("code",null,"name"),a(),s("strong",null,"string"),s("br"),a(" Name of the role.")],-1),m=s("p",null,[s("code",null,"icon"),a(),s("strong",null,"string"),s("br"),a(" Icon for the role. Displayed in the Admin App.")],-1),b=s("p",null,[s("code",null,"description"),a(),s("strong",null,"string"),s("br"),a(" Description for the role. Displayed in the Admin App.")],-1),y=s("p",null,[s("code",null,"ip_access"),a(),s("strong",null,"csv"),s("br"),a(" A CSV of IP addresses that have access to this role. Allows you to configure an allowlist of IP addresses.")],-1),f=s("p",null,[s("code",null,"enforce_tfa"),a(),s("strong",null,"boolean"),s("br"),a(" Whether or not Two-Factor Authentication is required for users in this role.")],-1),g=s("p",null,[s("code",null,"admin_access"),a(),s("strong",null,"boolean"),s("br"),a(" If this role is considered an admin role. This means that users in this role have full permissions to everything.")],-1),x=s("p",null,[s("code",null,"app_access"),a(),s("strong",null,"boolean"),s("br"),a(" Whether or not users in this role have access to use the Admin App.")],-1),q=s("code",null,"users",-1),k=s("strong",null,"one-to-many",-1),w=s("br",null,null,-1),R=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),a(`
+	`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Admin"'),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"supervised_user_circle"'),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"ip_access"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"enforce_tfa"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"users"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),s("span",{class:"hljs-punctuation"},"]"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),E=s("hr",null,null,-1),T=s("h2",{id:"list-roles",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-roles"},"#"),a(" List Roles")],-1),P=s("p",null,"List all roles that exist in Directus.",-1),A=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),a(" Query Parameters")],-1),S=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),a(" Returns")],-1),I=s("a",{href:"#the-role-object"},"role objects",-1),D=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),a(" REST API")],-1),L=s("pre",null,[s("code",null,`GET /roles
+SEARCH /roles
+`)],-1),Q=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),a(" GraphQL")],-1),C=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),v=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Query"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	`),s("span",{class:"hljs-symbol"},"roles"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("directus_roles"),s("span",{class:"hljs-punctuation"},"]"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),O=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),a(" Example")],-1),G=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	roles `),s("span",{class:"hljs-punctuation"},"{"),a(`
+		id
+		name
+		users `),s("span",{class:"hljs-punctuation"},"{"),a(`
+			email
+		`),s("span",{class:"hljs-punctuation"},"}"),a(`
+	`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),M=s("hr",null,null,-1),B=s("h2",{id:"retrieve-a-role",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-a-role"},"#"),a(" Retrieve a Role")],-1),H=s("p",null,"List an existing role by primary key.",-1),U=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),a(" Query Parameters")],-1),N=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),a(" Returns")],-1),V=s("p",null,[a("Returns the requested "),s("a",{href:"#the-role-object"},"role object"),a(".")],-1),z=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),a(" REST API")],-1),W=s("pre",null,[s("code",null,`GET /roles/:id
+`)],-1),F=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),a(" Example")],-1),J=s("pre",null,[s("code",null,`GET /roles/b4cb3b64-8580-4ad9-a099-eade6da24302
+`)],-1),K=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),a(" GraphQL")],-1),X=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Y=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Query"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	roles_by_id`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(" ID"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` directus_roles
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),Z=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),a(" Example")],-1),$=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	roles_by_id`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-number"},"2"),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+		id
+		name
+		users `),s("span",{class:"hljs-punctuation"},"{"),a(`
+			email
+		`),s("span",{class:"hljs-punctuation"},"}"),a(`
+	`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),ss=s("hr",null,null,-1),as=s("h2",{id:"create-a-role",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-a-role"},"#"),a(" Create a Role")],-1),ns=s("p",null,"Create a new role.",-1),ls=s("h3",{id:"query-parameters-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),a(" Query Parameters")],-1),ts=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),a(" Request Body")],-1),es=s("p",null,[a("A partial "),s("a",{href:"#the-role-object"},"role object"),a(".")],-1),cs=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),a(" Returns")],-1),os=s("p",null,[a("Returns the "),s("a",{href:"#the-role-object"},"role object"),a(" for the created role.")],-1),ps=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),a(" REST API")],-1),hs=s("pre",null,[s("code",null,`POST /roles
+`)],-1),rs=s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),a(" Example")],-1),us=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /roles"),a(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),a(`
+	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Interns"'),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"verified_user"'),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),is=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),a(" GraphQL")],-1),ds=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),js=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	create_roles_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(" create_directus_roles_input"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` directus_roles
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),_s=s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),a(" Example")],-1),ms=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	create_roles_item`),s("span",{class:"hljs-punctuation"},"("),a(`
+		`),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(),s("span",{class:"hljs-symbol"},"name"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Interns"'),a(", "),s("span",{class:"hljs-symbol"},"icon"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"verified_user"'),a(", "),s("span",{class:"hljs-symbol"},"description"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},"null"),a(", "),s("span",{class:"hljs-symbol"},"admin_access"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},"false"),a(", "),s("span",{class:"hljs-symbol"},"app_access"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},"true"),a(),s("span",{class:"hljs-punctuation"},"}"),a(`
+	`),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+		id
+		name
+		users `),s("span",{class:"hljs-punctuation"},"{"),a(`
+			email
+		`),s("span",{class:"hljs-punctuation"},"}"),a(`
+	`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),bs=s("hr",null,null,-1),ys=s("h2",{id:"create-multiple-roles",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-multiple-roles"},"#"),a(" Create Multiple Roles")],-1),fs=s("p",null,"Create multiple new roles.",-1),gs=s("h3",{id:"query-parameters-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),a(" Query Parameters")],-1),xs=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),a(" Request Body")],-1),qs=s("p",null,[a("An array of partial "),s("a",{href:"#the-role-object"},"role objects"),a(".")],-1),ks=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),a(" Returns")],-1),ws=s("p",null,[a("Returns the "),s("a",{href:"#the-role-object"},"role objects"),a(" for the created roles.")],-1),Rs=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),a(" REST API")],-1),Es=s("pre",null,[s("code",null,`POST /roles
+`)],-1),Ts=s("h5",{id:"example-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-5"},"#"),a(" Example")],-1),Ps=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /roles"),a(`
+
+`),s("span",{class:"hljs-punctuation"},"["),a(`
+	`),s("span",{class:"hljs-punctuation"},"{"),a(`
+		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Interns"'),s("span",{class:"hljs-punctuation"},","),a(`
+		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"verified_user"'),s("span",{class:"hljs-punctuation"},","),a(`
+		`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),a(`
+		`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),a(`
+		`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),a(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-punctuation"},"{"),a(`
+		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Customers"'),s("span",{class:"hljs-punctuation"},","),a(`
+		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"person"'),s("span",{class:"hljs-punctuation"},","),a(`
+		`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),a(`
+		`),s("span",{class:"hljs-attr"},'"admin_access"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),a(`
+		`),s("span",{class:"hljs-attr"},'"app_access"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),a(`
+	`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`),s("span",{class:"hljs-punctuation"},"]"),a(`
+`)])],-1),As=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),a(" GraphQL")],-1),Ss=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Is=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	create_roles_items`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("create_directus_roles_input"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("directus_roles"),s("span",{class:"hljs-punctuation"},"]"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),Ds=s("h5",{id:"example-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-6"},"#"),a(" Example")],-1),Ls=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	create_roles_items`),s("span",{class:"hljs-punctuation"},"("),a(`
+		`),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a(`
+			`),s("span",{class:"hljs-punctuation"},"{"),a(),s("span",{class:"hljs-symbol"},"name"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Interns"'),a(", "),s("span",{class:"hljs-symbol"},"icon"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"verified_user"'),a(", "),s("span",{class:"hljs-symbol"},"description"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},"null"),a(", "),s("span",{class:"hljs-symbol"},"admin_access"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},"false"),a(", "),s("span",{class:"hljs-symbol"},"app_access"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},"true"),a(),s("span",{class:"hljs-punctuation"},"}"),a(`
+			`),s("span",{class:"hljs-punctuation"},"{"),a(),s("span",{class:"hljs-symbol"},"name"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"Customers"'),a(", "),s("span",{class:"hljs-symbol"},"icon"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"person"'),a(", "),s("span",{class:"hljs-symbol"},"description"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},"null"),a(", "),s("span",{class:"hljs-symbol"},"admin_access"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},"false"),a(", "),s("span",{class:"hljs-symbol"},"app_access"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-literal"},"false"),a(),s("span",{class:"hljs-punctuation"},"}"),a(`
+		`),s("span",{class:"hljs-punctuation"},"]"),a(`
+	`),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+		id
+		name
+		users `),s("span",{class:"hljs-punctuation"},"{"),a(`
+			email
+		`),s("span",{class:"hljs-punctuation"},"}"),a(`
+	`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),Qs=s("hr",null,null,-1),Cs=s("h2",{id:"update-a-role",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-role"},"#"),a(" Update a Role")],-1),vs=s("p",null,"Update an existing role.",-1),Os=s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),a(" Query Parameters")],-1),Gs=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),a(" Request Body")],-1),Ms=s("p",null,[a("A partial "),s("a",{href:"#the-role-object"},"role object"),a(".")],-1),Bs=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),a(" Returns")],-1),Hs=s("p",null,[a("Returns the "),s("a",{href:"#the-role-object"},"role object"),a(" for the updated role.")],-1),Us=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),a(" REST API")],-1),Ns=s("pre",null,[s("code",null,`PATCH /roles/:id
+`)],-1),Vs=s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),a(" Example")],-1),zs=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7"),a(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),a(`
+	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"attractions"'),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),Ws=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),a(" GraphQL")],-1),Fs=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Js=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	update_roles_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(" ID"),s("span",{class:"hljs-punctuation"},"!"),a(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(" update_directus_roles_input"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` directus_roles
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),Ks=s("h5",{id:"example-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-8"},"#"),a(" Example")],-1),Xs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	update_roles_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),a(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(),s("span",{class:"hljs-symbol"},"icon"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"attractions"'),a(),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+		id
+		name
+		users `),s("span",{class:"hljs-punctuation"},"{"),a(`
+			email
+		`),s("span",{class:"hljs-punctuation"},"}"),a(`
+	`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),Ys=s("hr",null,null,-1),Zs=s("h2",{id:"update-multiple-roles",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-multiple-roles"},"#"),a(" Update Multiple Roles")],-1),$s=s("p",null,"Update multiple existing roles.",-1),sa=s("h3",{id:"query-parameters-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-5"},"#"),a(" Query Parameters")],-1),aa=s("h3",{id:"request-body-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-3"},"#"),a(" Request Body")],-1),na=s("p",null,[s("code",null,"keys"),a(),s("strong",null,"Required"),s("br"),a(" Array of primary keys of the roles you’d like to update.")],-1),la=s("p",null,[s("code",null,"data"),a(),s("strong",null,"Required"),s("br"),a(" Any of "),s("a",{href:"#the-role-object"},"the role object"),a("’s properties.")],-1),ta=s("h3",{id:"returns-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-5"},"#"),a(" Returns")],-1),ea=s("p",null,[a("Returns the "),s("a",{href:"#the-role-object"},"role objects"),a(" for the updated roles.")],-1),ca=s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),a(" REST API")],-1),oa=s("pre",null,[s("code",null,`PATCH /roles
+`)],-1),pa=s("h5",{id:"example-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-9"},"#"),a(" Example")],-1),ha=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /roles"),a(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),a(`
+	`),s("span",{class:"hljs-attr"},'"keys"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"6fc3d5d3-a37b-4da8-a2f4-ed62ad5abe03"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),a(`
+	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"attractions"'),a(`
+	`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),ra=s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),a(" GraphQL")],-1),ua=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),ia=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	update_roles_items`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"ids"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("ID"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},"!"),a(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(" update_directus_roles_input"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("directus_roles"),s("span",{class:"hljs-punctuation"},"]"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),da=s("h5",{id:"example-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-10"},"#"),a(" Example")],-1),ja=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	update_roles_items`),s("span",{class:"hljs-punctuation"},"("),a(`
+		`),s("span",{class:"hljs-symbol"},"ids"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),a(", "),s("span",{class:"hljs-string"},'"6fc3d5d3-a37b-4da8-a2f4-ed62ad5abe03"'),s("span",{class:"hljs-punctuation"},"]"),a(`
+		`),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"{"),a(),s("span",{class:"hljs-symbol"},"icon"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"attractions"'),a(),s("span",{class:"hljs-punctuation"},"}"),a(`
+	`),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+		id
+		name
+		users `),s("span",{class:"hljs-punctuation"},"{"),a(`
+			email
+		`),s("span",{class:"hljs-punctuation"},"}"),a(`
+	`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),_a=s("hr",null,null,-1),ma=s("h2",{id:"delete-a-role",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-a-role"},"#"),a(" Delete a Role")],-1),ba=s("p",null,"Delete an existing role.",-1),ya=s("h3",{id:"returns-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-6"},"#"),a(" Returns")],-1),fa=s("p",null,"Empty body.",-1),ga=s("h3",{id:"rest-api-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-6"},"#"),a(" REST API")],-1),xa=s("pre",null,[s("code",null,`DELETE /roles/:id
+`)],-1),qa=s("h5",{id:"example-11",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-11"},"#"),a(" Example")],-1),ka=s("pre",null,[s("code",null,`DELETE /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7
+`)],-1),wa=s("h3",{id:"graphql-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-6"},"#"),a(" GraphQL")],-1),Ra=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Ea=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	delete_roles_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(" ID"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` delete_one
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),Ta=s("h5",{id:"example-12",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-12"},"#"),a(" Example")],-1),Pa=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	delete_roles_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"id"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+		id
+	`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),Aa=s("hr",null,null,-1),Sa=s("h2",{id:"delete-multiple-roles",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-multiple-roles"},"#"),a(" Delete Multiple Roles")],-1),Ia=s("p",null,"Delete multiple existing roles.",-1),Da=s("h3",{id:"request-body-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-4"},"#"),a(" Request Body")],-1),La=s("p",null,"An array of role primary keys",-1),Qa=s("h3",{id:"returns-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-7"},"#"),a(" Returns")],-1),Ca=s("p",null,"Empty body.",-1),va=s("h3",{id:"rest-api-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-7"},"#"),a(" REST API")],-1),Oa=s("pre",null,[s("code",null,`DELETE /roles
+`)],-1),Ga=s("h5",{id:"example-13",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-13"},"#"),a(" Example")],-1),Ma=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /roles"),a(`
+`),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),s("span",{class:"hljs-punctuation"},","),a(),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},"]"),a(`
+`)])],-1),Ba=s("h3",{id:"graphql-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-7"},"#"),a(" GraphQL")],-1),Ha=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Ua=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),a(),s("span",{class:"hljs-keyword"},"Mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	delete_roles_items`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"ids"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),a("ID"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),a(` delete_many
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),Na=s("h5",{id:"example-14",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-14"},"#"),a(" Example")],-1),Va=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+	delete_roles_items`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"ids"),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),a(", "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},")"),a(),s("span",{class:"hljs-punctuation"},"{"),a(`
+		ids
+	`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`),s("span",{class:"hljs-punctuation"},"}"),a(`
+`)])],-1),za=s("hr",null,null,-1),Xa="Roles",Ya=!1,Za="REST and GraphQL API documentation on the Roles collection in Directus.",$a="5 min read",sn="page-reference",an={__name:"roles",setup(Wa,{expose:o}){const e={title:"Roles",modularExtension:!1,description:"REST and GraphQL API documentation on the Roles collection in Directus.",readTime:"5 min read",pageClass:"page-reference"};return o({frontmatter:e}),(Fa,Ja)=>{const l=c("router-link"),p=c("docs-wrapper");return h(),r(p,{frontmatter:e},{default:n(()=>[s("div",u,[s("blockquote",null,[s("p",null,[a("Roles define a specific set of access permissions, and are the primary organizational structure for Users within the platform. "),t(l,{to:"/docs/getting-started/glossary#roles"},{default:n(()=>[a("Learn more about Roles")]),_:1}),a(".")])]),i,d,j,_,m,b,y,f,g,x,s("p",null,[q,a(),k,w,a(" The users in this role. One-to-many to "),t(l,{to:"/docs/reference/system/users"},{default:n(()=>[a("users")]),_:1}),a(".")]),R,E,T,P,A,s("p",null,[a("Supports all "),t(l,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),S,s("p",null,[a("An array of up to "),t(l,{to:"/docs/reference/query#limit"},{default:n(()=>[a("limit")]),_:1}),a(),I,a(". If no items are available, data will be an empty array.")]),D,L,s("p",null,[t(l,{to:"/docs/reference/introduction#search-http-method"},{default:n(()=>[a("Learn more about SEARCH ->")]),_:1})]),Q,C,v,O,G,M,B,H,U,s("p",null,[a("Supports all "),t(l,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),N,V,z,W,F,J,K,X,Y,Z,$,ss,as,ns,ls,s("p",null,[a("Supports all "),t(l,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),ts,es,cs,os,ps,hs,rs,us,is,ds,js,_s,ms,bs,ys,fs,gs,s("p",null,[a("Supports all "),t(l,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),xs,qs,ks,ws,Rs,Es,Ts,Ps,As,Ss,Is,Ds,Ls,Qs,Cs,vs,Os,s("p",null,[a("Supports all "),t(l,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),Gs,Ms,Bs,Hs,Us,Ns,Vs,zs,Ws,Fs,Js,Ks,Xs,Ys,Zs,$s,sa,s("p",null,[a("Supports all "),t(l,{to:"/docs/reference/query"},{default:n(()=>[a("global query parameters")]),_:1}),a(".")]),aa,na,la,ta,ea,ca,oa,pa,ha,ra,ua,ia,da,ja,_a,ma,ba,ya,fa,ga,xa,qa,ka,wa,Ra,Ea,Ta,Pa,Aa,Sa,Ia,Da,La,Qa,Ca,va,Oa,Ga,Ma,Ba,Ha,Ua,Na,Va,za])]),_:1})}}};export{an as default,Za as description,Ya as modularExtension,sn as pageClass,$a as readTime,Xa as title};

package/dist/assets/roles-684aeeed.js

@@ -0,0 +1 @@
+import{a as n,o as c,e as u,y as o,u as e,q as s,z as t}from"./runtime-core.esm-bundler-753bcc58.js";const d={class:"markdown-body"},p=e("blockquote",null,[e("p",null,"Roles are essentially a bundle of pre-configured access permissions which you can (re)assign to any number of users.")],-1),h={class:"tip hint"},m=e("div",{class:"hint-title"},"Learn More",-1),g=e("h2",{id:"view-a-role",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#view-a-role"},"#"),s(" View a Role")],-1),_=e("video",{title:"Create a Role",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/roles-20220909/view-a-role-20220908A.mp4",type:"video/mp4"})],-1),f=e("p",null,[s("To view an existing role, navigate to "),e("strong",null,"Settings > Roles & Permissions > [Role]"),s(". Now you can see the role’s permissions and other details.")],-1),v=e("h2",{id:"create-a-role",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-role"},"#"),s(" Create a Role")],-1),w=e("video",{title:"Create a Role",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/roles-20220909/create-a-role-20220908A.mp4",type:"video/mp4"})],-1),y=e("p",null,"To create a role, follow these steps.",-1),R=e("ol",null,[e("li",null,[s("Navigate to "),e("strong",null,"Settings > Roles & Permissions"),s(".")]),e("li",null,[s("Click "),e("span",{mi:"",btn:""},"add"),s(" in the page header.")]),e("li",null,[s("Enter a unique "),e("strong",null,"Role Name"),s(".")]),e("li",null,[s("Toggle "),e("strong",null,"App Access"),s(" and "),e("strong",null,"Admin Access"),s(" as desired."),e("br"),s(" To learn more, see "),e("a",{href:"#configure-role-details"},"configure role details"),s(".")]),e("li",null,[s("Click "),e("strong",null,"Save"),s(" to confirm.")])],-1),A=e("div",{class:"tip hint"},[e("p",null,[s("Next, you will likely need to "),e("a",{href:"#configure-role-details"},"configure the role’s details"),s(" and "),e("a",{href:"#configure-role-permissions"},"configure the role’s permissions"),s(".")])],-1),b=e("h2",{id:"configure-role-details",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#configure-role-details"},"#"),s(" Configure Role Details")],-1),C=e("video",{title:"Configure Role Details",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/roles-20220909/configure-role-details-20220907A.mp4",type:"video/mp4"})],-1),x=e("p",null,"In addition to defining permissions, roles come with a number of other configuration options. To configure a role’s details, follow these steps.",-1),k=e("ol",null,[e("li",null,[s("Navigate to "),e("strong",null,"Settings > Roles & Permissions > [Role]"),s(".")]),e("li",null,[s("Configure the following options as desired: "),e("ul",null,[e("li",null,[e("strong",null,"Permissions"),s(" — Configures "),e("a",{href:"#configure-permissions"},"access permissions"),s(" for the role.")]),e("li",null,[e("strong",null,"Role Name"),s(" — Sets the name of the role.")]),e("li",null,[e("strong",null,"Role Icon"),s(" — Sets icon used when referencing this role.")]),e("li",null,[e("strong",null,"Description"),s(" — Adds a note to help explain the role’s purpose.")]),e("li",null,[e("strong",null,"App Access"),s(" — Auto-configures minimum permissions required to log in to the App.")]),e("li",null,[e("strong",null,"Admin Access"),s(" — Auto-configures full permissions to project data and Settings. Must be toggled off to restore ability to restrict permissions.")]),e("li",null,[e("strong",null,"IP Access"),s(" — Adds IP addresses to allow list. Type IP in and hit "),e("code",null,"Enter"),s(" (PC) or "),e("code",null,"return"),s(" (Mac) to confirm. Leave empty to allow all IP addresses.")]),e("li",null,[e("strong",null,"Require MFA"),s(" — Forces all users within this role to use multi-factor authentication.")]),e("li",null,[e("strong",null,"Users in Role"),s(" — Lists all users within this role.")])])]),e("li",null,[s("Click "),e("span",{mi:"",btn:""},"check"),s(" in the page header to confirm.")])],-1),T={class:"tip hint"},N=e("div",{class:"hint-title"},"App Access vs Admin Access",-1),P=e("em",null,"App Access",-1),D=e("em",null,"Admin",-1),I=e("em",null,"App Access",-1),S=e("h2",{id:"delete-a-role",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-a-role"},"#"),s(" Delete a Role")],-1),q=e("video",{title:"Create a Role",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/users-roles-permissions/roles-20220909/delete-a-role-20220907A.mp4",type:"video/mp4"})],-1),L=e("p",null,"To delete a role, follow these steps.",-1),B=e("ol",null,[e("li",null,[s("Navigate to "),e("strong",null,"Settings > Roles & Permissions > [Role]"),s(".")]),e("li",null,[s("Click "),e("span",{mi:"",btn:"",dngr:""},"delete"),s(" in the page header and a popup will appear.")]),e("li",null,[s("Click "),e("strong",null,"Delete"),s(" to confirm.")])],-1),E={class:"warning hint"},M=e("div",{class:"hint-title"},"Users in a Deleted Role",-1),V=e("code",null,"NULL",-1),U={class:"tip hint"},F=e("div",{class:"hint-title"},"Built-in Roles",-1),G="Roles",J=!1,K="Roles are essentially a bundle of pre-configured access permissions which you can (re)assign to any number of users.",O=null,Q={__name:"roles",setup(j,{expose:r}){const i={title:"Roles",modularExtension:!1,description:"Roles are essentially a bundle of pre-configured access permissions which you can (re)assign to any number of users.",readTime:null};return r({frontmatter:i}),(z,H)=>{const l=n("router-link"),a=n("docs-wrapper");return c(),u(a,{frontmatter:i},{default:o(()=>[e("div",d,[p,e("div",h,[m,e("p",null,[s("To configure roles programmatically, see our API documentation on "),t(l,{to:"/docs/reference/system/roles.md"},{default:o(()=>[s("roles")]),_:1}),s(".")])]),g,_,f,v,w,y,R,A,b,C,x,k,e("div",T,[N,e("p",null,[s("Roles with "),P,s(" enabled are created with the minimum permissions required to login to the app and access their own profile information. Roles that have neither "),D,s(" nor "),I,s(" enabled are created with public permissions. You can always "),t(l,{to:"/docs/configuration/users-roles-permissions/permissions.md#configure-permissions"},{default:o(()=>[s("reconfigure permissions")]),_:1}),s(" later.")])]),S,q,L,B,e("div",E,[M,e("p",null,[s("If you delete a role that still has users in it, those users will be given a "),V,s(" role, which limits them to public permissions. However, you can always "),t(l,{to:"/docs/configuration/users-roles-permissions/users.md#assign-role-to-existing-user"},{default:o(()=>[s("assign them a new role")]),_:1}),s(".")])]),e("div",U,[F,e("p",null,[s("Directus does not allow you to delete the built-in public role or administrator role. To learn more, please see the introductory section on "),t(l,{to:"/docs/configuration/users-roles-permissions.html#directus-roles"},{default:o(()=>[s("Directus Roles")]),_:1}),s(".")])])])]),_:1})}}};export{Q as default,K as description,J as modularExtension,O as readTime,G as title};

package/dist/assets/rpm-78df69ce.js

@@ -0,0 +1 @@
+import{z as d}from"./index.5b245cc4.entry.js";function g(a,f){for(var e=0;e<f.length;e++){const n=f[e];if(typeof n!="string"&&!Array.isArray(n)){for(const t in n)if(t!=="default"&&!(t in a)){const c=Object.getOwnPropertyDescriptor(n,t);c&&Object.defineProperty(a,t,c.get?c:{enumerable:!0,get:()=>n[t]})}}}return Object.freeze(Object.defineProperty(a,Symbol.toStringTag,{value:"Module"}))}var p={};(function(a,f){(function(e){e(d)})(function(e){e.defineMode("rpm-changes",function(){var n=/^-+$/,t=/^(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} - /,c=/^[\w+.-]+@[\w.-]+/;return{token:function(i){return i.sol()&&(i.match(n)||i.match(t))?"tag":i.match(c)?"string":(i.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)/,t=/^[a-zA-Z0-9()]+:/,c=/^%(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)/,i=/^%(ifnarch|ifarch|if)/,l=/^%(else|endif)/,u=/^(\!|\?|\<\=|\<|\>\=|\>|\=\=|\&\&|\|\|)/;return{startState:function(){return{controlFlow:!1,macroParameters:!1,section:!1}},token:function(r,o){var h=r.peek();if(h=="#")return r.skipToEnd(),"comment";if(r.sol()){if(r.match(t))return"header";if(r.match(c))return"atom"}if(r.match(/^\$\w+/)||r.match(/^\$\{\w+\}/))return"def";if(r.match(l))return"keyword";if(r.match(i))return o.controlFlow=!0,"keyword";if(o.controlFlow){if(r.match(u))return"operator";if(r.match(/^(\d+)/))return"number";r.eol()&&(o.controlFlow=!1)}if(r.match(n))return r.eol()&&(o.controlFlow=!1),"number";if(r.match(/^%[\w]+/))return r.match("(")&&(o.macroParameters=!0),"keyword";if(o.macroParameters){if(r.match(/^\d+/))return"number";if(r.match(")"))return o.macroParameters=!1,"keyword"}return r.match(/^%\{\??[\w \-\:\!]+\}/)?(r.eol()&&(o.controlFlow=!1),"def"):(r.next(),null)}}}),e.defineMIME("text/x-rpm-spec","rpm-spec")})})();const m=g({__proto__:null,default:p},[p]);export{m as r};

package/dist/assets/rst-db8df65a.js

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