Permission

Permission objects are used to define resource access controls.



The resource access permission definition. Used to provide fine granular access control over API resources.

Permission [Schema]

Name Type Required Description
Name xsd:string ( min: 3 max: 100)
Pattern: [A-Za-z0-9_\. ]+
yes Permission display name.
Description xsd:string ( max: 250) no Permission description text (Optional).
Expression xsd:string ( min: 1 max: 1000) yes Permission resource expression. Used to identify which resource locations are affected by this permission specification.
Verbs xsd:string
Pattern: (?:(?:Read|Write|Delete|All)\s?)+
yes Permission verbs. Identifies the action(s) matched to this permission specification. Possible values: Read, Write, Delete or All. Multiple verbs allowed separated by space characters e.g. Read Write.
Policy xsd:string (enumeration)
  • Allow
  • Deny
yes Permission policy. used to indicate if this policy allows or denies access to the matched resources.

Example

<?xml version="1.0"?>
<Permission xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Name>string</Name>
  <Description>string</Description>
  <Expression>string</Expression>
  <Verbs />
  <Policy>Allow</Policy>
</Permission>
{
  "Permission": {
    "Name": "string",
    "Description": "string",
    "Expression": "string",
    "Verbs": null,
    "Policy": "Allow"
  }
}