awe Permissions Schema
Generated from permissions.xsd.
This Schema defines the way an awe Permissions file (permission catalog of a module) must be structured. A permission identifier is <resource>.<verb> or <resource>.<action>
4 elements, 8 declared attributes (8 documented).
Elements​
Elements: permissions, verb, resource, action
permissions​
Type: permissionsType
Contains: verb (0..n), resource (0..n)
Contained by: none (document root)
Attributes: none
verb​
Type: permissionVerbType
Contains: no child elements
Contained by: permissions
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | permissionIdentifierType | yes | Verb identifier: the last part of the permissions of the resources that list it (read in users.read) | |
label | string | yes | Locale key of the name of the verb, shown in the permissions of a profile |
resource​
Type: permissionResourceType
Contains: action (0..n)
Contained by: permissions
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | permissionIdentifierType | yes | Resource identifier: the first part of its permissions (users in users.read) | |
label | string | yes | Locale key of the name of the resource, the group of its permissions in the permissions of a profile | |
verbs | permissionVerbListType | no | Comma separated verb list. 'crud' means read, create, update and delete. The 'write' verb exists only for the 'default' resource | |
granted | always | no | 'always' grants the permissions of the resource to every authenticated user |
action​
Type: permissionActionType
Contains: no child elements
Contained by: resource
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | permissionIdentifierType | yes | Action identifier: the last part of an own permission of the resource (unlock in users.unlock) | |
label | string | yes | Locale key of the name of the action, shown in the permissions of a profile |
Simple types​
permissionIdentifierType​
Base type: string
Pattern: [A-Za-z0-9_\-]+
permissionVerbListType​
Base type: string
Pattern: [A-Za-z0-9_\-]+( *, *[A-Za-z0-9_\-]+)*
permissionGrantedEnum​
Base type: string
Allowed values: always