Permission DataType

The Permission type represents access control decisions, indicating whether an action should be allowed or denied.

Definition

Type URL https://rustybeam.net/schema/Permission
Base Type text
Validation Pattern ^(?i)(allow|deny)$
Constraints {"case_insensitive": true}

Allowed Values

Value Meaning Example Usage
Allow Grant access or permit the action User can read the resource
Deny Refuse access or block the action User cannot delete the resource

Note: Values are case-insensitive. Allow, allow, ALLOW are all valid and equivalent.

Usage in Property Definitions

Permission is typically used in authorization rules and access control schemas:

<tr itemscope itemtype="https://rustybeam.net/schema/Property">
    <td><span itemprop="name">effect</span></td>
    <td><span itemprop="type">Permission</span></td>
    <td><span itemprop="cardinality">1</span></td>
    <td><span itemprop="description">Whether to allow or deny the action</span></td>
</tr>

Usage in Data

<span itemprop="effect">Allow</span>

Validation

Validation software should:

  1. Accept any case variation of "allow" or "deny"
  2. Normalize to canonical form (typically "Allow" or "Deny" with capital first letter)
  3. Reject any other values

Common Use Cases

See Also