ldap-rest 0.6.2 → 0.8.0

package/static/schemas/example/groups.json

@@ -0,0 +1,94 @@
+{
+  "entity": {
+    "name": "mailingList",
+    "mainAttribute": "cn",
+    "objectClass": ["top", "groupOfNames", "twakeStaticGroup"],
+    "singularName": "mailingList",
+    "pluralName": "mailingLists",
+    "base": "ou=lists,ou=groups,__ldap_base__"
+  },
+  "strict": true,
+  "attributes": {
+    "objectClass": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "test": "^[a-zA-Z][a-zA-Z0-9-]*$"
+      },
+      "default": ["top", "groupOfNames", "twakeStaticGroup"],
+      "required": true,
+      "fixed": true
+    },
+    "cn": {
+      "type": "string",
+      "searchable": true,
+      "test": "^(?!.*\\.\\.)[a-zA-Z0-9!#$%&'*+/=?^_`{|}.-]{1,64}$",
+      "hint": "Must match an email local part, at most 64 characters, no consecutive dots",
+      "required": true,
+      "role": "identifier",
+      "label": "Mailing list name"
+    },
+    "description": {
+      "type": "string",
+      "searchable": true,
+      "required": false
+    },
+    "mail": {
+      "type": "string",
+      "searchable": true,
+      "test": "^[^@\\s]{1,64}@([^@\\s]{1,245}\\.)?example\\.org$",
+      "hint": "Expected an address in example.org or one of its subdomains",
+      "required": true,
+      "unique": {
+        "attributes": ["mailAlternateAddress"],
+        "branches": ["__LDAP_BASE__"]
+      },
+      "mailDomainScope": "organization",
+      "allowSubdomains": true,
+      "role": "primaryEmail"
+    },
+    "businessCategory": {
+      "type": "pointer",
+      "branch": ["ou=twakeListType,ou=nomenclature,__LDAP_BASE__"],
+      "required": false,
+      "role": "writePolicy",
+      "label": "List type"
+    },
+    "member": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "test": "^[a-zA-Z]+=.*,__LDAP_BASE__$",
+        "hint": "Expected the DN of an entry of this directory"
+      },
+      "required": false,
+      "deleteGuard": "nonEmpty",
+      "role": "members",
+      "label": "Members"
+    },
+    "owner": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "test": "^[a-zA-Z]+=.*,__LDAP_BASE__$",
+        "hint": "Expected the DN of an entry of this directory"
+      },
+      "required": false,
+      "role": "owners"
+    },
+    "twakeDepartmentLink": {
+      "type": "pointer",
+      "branch": ["ou=organization,__LDAP_BASE__"],
+      "required": true,
+      "role": "organizationLink",
+      "label": "Department"
+    },
+    "twakeDepartmentPath": {
+      "type": "string",
+      "test": "^[^\\r\\n]{1,4096}$",
+      "required": true,
+      "generated": true,
+      "role": "organizationPath"
+    }
+  }
+}

package/static/schemas/example/nomenclature/domains.json

@@ -0,0 +1,49 @@
+{
+  "entity": {
+    "name": "domain",
+    "mainAttribute": "dc",
+    "objectClass": ["top", "domain", "domainRelatedObject"],
+    "singularName": "domain",
+    "pluralName": "domains",
+    "base": "ou=domains,ou=nomenclature,{ldap_base}",
+    "label": {
+      "en": "Mail domains",
+      "fr": "Domaines de messagerie"
+    },
+    "singularLabel": {
+      "en": "domain",
+      "fr": "domaine"
+    }
+  },
+  "strict": true,
+  "attributes": {
+    "objectClass": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "default": ["top", "domain", "domainRelatedObject"],
+      "required": true,
+      "fixed": true
+    },
+    "dc": {
+      "type": "string",
+      "test": "^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$",
+      "hint": "A single domain label: letters, digits and hyphens, e.g. example",
+      "required": true,
+      "role": "identifier"
+    },
+    "associatedDomain": {
+      "type": "string",
+      "test": "^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+$|^\\*$",
+      "hint": "A fully qualified domain name (example.org), or * to allow every domain",
+      "required": true,
+      "role": "domainName",
+      "label": "Mail domain"
+    },
+    "description": {
+      "type": "string",
+      "required": false
+    }
+  }
+}

package/static/schemas/example/organizations.json

@@ -0,0 +1,106 @@
+{
+  "entity": {
+    "label": {
+      "en": "Organizations",
+      "fr": "Organisations"
+    },
+    "singularLabel": {
+      "en": "organization",
+      "fr": "organisation"
+    }
+  },
+  "strict": true,
+  "attributes": {
+    "objectClass": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "test": "^[a-zA-Z][a-zA-Z0-9-]*$"
+      },
+      "default": ["top", "organizationalUnit", "twakeDepartment"],
+      "required": true,
+      "fixed": true
+    },
+    "ou": {
+      "type": "string",
+      "searchable": true,
+      "test": "^[A-ZÀ-ÖØ-Þ]((?!.*([-,’'()&]{2}|\\s{2}|\\s[-,’')]|[-’'(]\\s|\\)[^\\s]|[^\\s]\\())[a-zA-ZÀ-ÖØ-öø-ÿ0-9,\\s\\-’'()&])*[a-zà-öø-ÿ)]$",
+      "hint": "Starts with a capital and ends with a lowercase letter or ), no repeated punctuation",
+      "required": true,
+      "unique": true,
+      "role": "identifier",
+      "label": "Department name"
+    },
+    "description": {
+      "type": "string",
+      "searchable": true,
+      "required": false
+    },
+    "telephoneNumber": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "test": "^\\(\\+99\\)\\s\\d{3}\\s\\d{4}$",
+        "hint": "Expected pattern (+99) 999 9999"
+      },
+      "required": false,
+      "label": "Phone"
+    },
+    "facsimileTelephoneNumber": {
+      "type": "string",
+      "test": "^\\(\\+99\\)\\s\\d{3}\\s\\d{4}$",
+      "hint": "Expected pattern (+99) 999 9999",
+      "required": false,
+      "label": "Fax"
+    },
+    "l": {
+      "type": "string",
+      "required": false,
+      "label": "Locality"
+    },
+    "postalAddress": {
+      "type": "string",
+      "test": "^[A-Z0-9À-ÖØ-öø-ÿ]((?!.*([-,'’()&/.]{2}|\\s{2}|\\s[,'’.)]|['’.(]\\s|\\)[^\\s]|[^\\s]\\())[a-zA-ZÀ-ÖØ-öø-ÿ0-9,\\s\\-'’()&/.])*[A-Za-zÀ-ÖØ-öø-ÿ0-9)]$",
+      "hint": "Starts with a capital or a digit, no repeated punctuation, ends with a letter, a digit or )",
+      "required": false,
+      "label": "Address"
+    },
+    "twakeDepartmentPath": {
+      "type": "string",
+      "test": "^[^\\r\\n]{1,4096}$",
+      "required": true,
+      "generated": true,
+      "role": "organizationPath"
+    },
+    "twakeManagerLink": {
+      "type": "array",
+      "items": {
+        "type": "pointer",
+        "branch": ["ou=users,__LDAP_BASE__"]
+      },
+      "required": false,
+      "role": "managers",
+      "label": "Managers"
+    },
+    "twakeDomainLink": {
+      "type": "array",
+      "items": {
+        "type": "pointer",
+        "branch": ["ou=domains,ou=nomenclature,__LDAP_BASE__"]
+      },
+      "required": false,
+      "role": "domainLink",
+      "label": "Mail domains"
+    },
+    "twakeLocalAdminLink": {
+      "type": "array",
+      "items": {
+        "type": "pointer",
+        "branch": ["ou=users,__LDAP_BASE__"]
+      },
+      "required": false,
+      "role": "localAdmins",
+      "label": "Local administrators"
+    }
+  }
+}

package/static/schemas/example/positions.json

@@ -0,0 +1,35 @@
+{
+  "entity": {
+    "name": "position",
+    "mainAttribute": "cn",
+    "objectClass": ["top", "twakePosition"],
+    "singularName": "position",
+    "pluralName": "positions",
+    "base": "ou=positions,{ldap_base}"
+  },
+  "strict": true,
+  "attributes": {
+    "objectClass": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "test": "^[a-zA-Z][a-zA-Z0-9-]*$"
+      },
+      "default": ["top", "twakePosition"],
+      "required": true,
+      "fixed": true
+    },
+    "cn": {
+      "type": "string",
+      "test": "^[a-zA-ZÀ-ÖØ-öø-ÿ](?!.*([-'’/,&()]{2}|\\s{2}|\\s[-,'’]|\\s[-'’]\\s|\\s\\)|\\(\\s|\\)[^\\s]|[^\\s]\\())[a-zA-ZÀ-ÖØ-öø-ÿ'’ \\-/,&()]+[a-zA-Z]$",
+      "hint": "Letters, spaces and ' - / , & ( ), starting and ending with a letter, no repeated punctuation",
+      "required": true,
+      "role": "identifier",
+      "label": "Position name"
+    },
+    "description": {
+      "type": "string",
+      "required": false
+    }
+  }
+}

package/static/schemas/example/users.json

@@ -0,0 +1,246 @@
+{
+  "entity": {
+    "name": "user",
+    "mainAttribute": "uid",
+    "objectClass": ["top", "twakeAccount", "twakeWhitePages"],
+    "singularName": "user",
+    "pluralName": "users",
+    "base": "ou=users,__ldap_base__"
+  },
+  "strict": true,
+  "attributes": {
+    "objectClass": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "test": "^[a-zA-Z][a-zA-Z0-9-]*$"
+      },
+      "default": ["top", "twakeAccount", "twakeWhitePages"],
+      "required": true,
+      "fixed": true
+    },
+    "uid": {
+      "type": "string",
+      "searchable": true,
+      "test": "^[a-zA-Z0-9._-]{1,255}$",
+      "required": true,
+      "role": "identifier",
+      "generated": true,
+      "generatedFrom": {
+        "attribute": "mail",
+        "extract": "^([^@]+)@",
+        "lowercase": true,
+        "strip": "[^a-zA-Z0-9._-]",
+        "onCollision": "suffix"
+      }
+    },
+    "employeeNumber": {
+      "type": "string",
+      "searchable": true,
+      "test": "^([A-Z0-9]{6,9}|[A-Z][A-Z0-9]{13}|UNIT)$",
+      "hint": "Expected 6 to 9 characters, or a letter followed by 13 characters, or UNIT",
+      "required": true,
+      "unique": {
+        "sentinel": "UNIT"
+      },
+      "role": "employeeId",
+      "label": "Employee ID"
+    },
+    "cn": {
+      "type": "string",
+      "searchable": true,
+      "required": false
+    },
+    "sn": {
+      "type": "string",
+      "searchable": true,
+      "test": "^[A-ZÀ-ÖØ-Þ](?!.*([\\s’'-]{2}|[.’'-]{2}|\\s\\.|[\\s’'-]$))[A-Za-zÀ-ÖØ-öø-ÿ\\s’'.-]{1,50}$",
+      "hint": "Starts with a capital, up to 51 letters, no repeated space, apostrophe, hyphen or dot",
+      "required": true,
+      "label": "Last name"
+    },
+    "givenName": {
+      "type": "string",
+      "searchable": true,
+      "test": "^[A-ZÀ-ÖØ-Þ](?!.*([\\s’'-]{2}|[.’'-]{2}|\\s\\.|[\\s’'-]$))[A-Za-zÀ-ÖØ-öø-ÿ\\s’'.-]{1,50}$",
+      "hint": "Starts with a capital, up to 51 letters, no repeated space, apostrophe, hyphen or dot",
+      "required": true,
+      "label": "First name"
+    },
+    "displayName": {
+      "type": "string",
+      "role": "displayName",
+      "required": true
+    },
+    "personalTitle": {
+      "type": "pointer",
+      "branch": ["ou=twakeTitle,ou=nomenclature,__LDAP_BASE__"],
+      "required": false,
+      "label": "Title"
+    },
+    "title": {
+      "type": "pointer",
+      "branch": ["ou=positions,__LDAP_BASE__"],
+      "required": false,
+      "referentialIntegrity": "restrict",
+      "role": "position",
+      "label": "Position"
+    },
+    "description": {
+      "type": "string",
+      "required": false,
+      "label": "Comment"
+    },
+    "mail": {
+      "type": "string",
+      "searchable": true,
+      "test": "^[^@\\s]{1,64}@example\\.org$",
+      "hint": "Expected an address in the example.org domain, at most 64 characters before the @",
+      "required": true,
+      "unique": {
+        "attributes": ["mailAlternateAddress"],
+        "branches": ["__LDAP_BASE__"]
+      },
+      "mailDomainScope": "organization",
+      "role": "primaryEmail"
+    },
+    "mailAlternateAddress": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "test": "^[^@\\s]{1,64}@example\\.org$",
+        "hint": "Expected an address in the example.org domain, at most 64 characters before the @"
+      },
+      "required": false,
+      "unique": {
+        "attributes": ["mail"],
+        "branches": ["__LDAP_BASE__"]
+      },
+      "mailDomainScope": "organization",
+      "role": "emailAliases"
+    },
+    "twakeOtherMailbox": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "test": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$",
+        "hint": "Expected an external email address"
+      },
+      "required": false,
+      "group": "Mailbox Settings"
+    },
+    "mailQuotaSize": {
+      "type": "number",
+      "required": false,
+      "role": "emailQuotaSize",
+      "normalize": "byteSize",
+      "default": 1000000000,
+      "hint": "Expected pattern xGB, xMB, xKB or a number of bytes",
+      "group": "Mailbox Settings"
+    },
+    "telephoneNumber": {
+      "type": "string",
+      "test": "^\\(\\+99\\)\\s\\d{3}\\s\\d{4}$",
+      "hint": "Expected pattern (+99) 999 9999",
+      "required": false,
+      "label": "Phone"
+    },
+    "mobile": {
+      "type": "string",
+      "test": "^\\(\\+99\\)\\s5\\d{3}\\s\\d{4}$",
+      "hint": "Expected pattern (+99) 5999 9999",
+      "required": false
+    },
+    "postalAddress": {
+      "type": "string",
+      "test": "^[A-Z0-9À-ÖØ-öø-ÿ]((?!.*([-,'’()&/.]{2}|\\s{2}|\\s[,'’.)]|['’.(]\\s|\\)[^\\s]|[^\\s]\\())[a-zA-ZÀ-ÖØ-öø-ÿ0-9,\\s\\-'’()&/.])*[A-Za-zÀ-ÖØ-öø-ÿ0-9)]$",
+      "hint": "Starts with a capital or a digit, no repeated punctuation, ends with a letter, a digit or )",
+      "required": false,
+      "label": "Address"
+    },
+    "postalCode": {
+      "type": "string",
+      "test": "^[AR1-9][0-9]{4}$",
+      "hint": "Expected pattern 9999, A9999 or R9999",
+      "required": false,
+      "label": "Zip code"
+    },
+    "l": {
+      "type": "string",
+      "test": "^[A-Za-zÀ-ÖØ-Þ](?!.*(['’\\s-]{2}))[A-Za-zÀ-ÖØ-öø-ÿ'’\\s-]*$",
+      "hint": "Letters, spaces, apostrophes and hyphens, none of them repeated",
+      "required": false,
+      "label": "Locality"
+    },
+    "userPassword": {
+      "type": "string",
+      "required": false,
+      "role": "password",
+      "neverReturn": true
+    },
+    "pwdReset": {
+      "type": "boolean",
+      "required": false,
+      "role": "passwordReset",
+      "neverReturn": true
+    },
+    "twakeDepartmentLink": {
+      "type": "pointer",
+      "branch": ["ou=organization,__LDAP_BASE__"],
+      "required": true,
+      "role": "organizationLink",
+      "label": "Department"
+    },
+    "twakeDepartmentPath": {
+      "type": "string",
+      "test": "^[^\\r\\n]{1,4096}$",
+      "required": true,
+      "generated": true,
+      "role": "organizationPath"
+    },
+    "twakeAccountStatus": {
+      "type": "pointer",
+      "branch": ["ou=twakeAccountStatus,ou=nomenclature,__LDAP_BASE__"],
+      "required": true,
+      "generated": true,
+      "role": "accountStatus",
+      "default": "cn=active,ou=twakeAccountStatus,ou=nomenclature,__LDAP_BASE__",
+      "states": {
+        "enabled": "cn=active,ou=twakeAccountStatus,ou=nomenclature,__LDAP_BASE__",
+        "disabled": "cn=disabled,ou=twakeAccountStatus,ou=nomenclature,__LDAP_BASE__",
+        "noAccess": "cn=noaccess,ou=twakeAccountStatus,ou=nomenclature,__LDAP_BASE__",
+        "toDelete": "cn=todelete,ou=twakeAccountStatus,ou=nomenclature,__LDAP_BASE__"
+      }
+    },
+    "twakeDeliveryMode": {
+      "type": "array",
+      "items": {
+        "type": "pointer",
+        "branch": ["ou=twakeDeliveryMode,ou=nomenclature,__LDAP_BASE__"]
+      },
+      "required": true,
+      "generated": true,
+      "default": [
+        "cn=normal,ou=twakeDeliveryMode,ou=nomenclature,__LDAP_BASE__"
+      ],
+      "group": "Mailbox Settings"
+    },
+    "twakeDeletionDate": {
+      "type": "date",
+      "required": false,
+      "role": "accountExpiry",
+      "hint": "Expected pattern MM/DD/YYYY, not earlier than today",
+      "label": "Deletion date"
+    },
+    "memberOf": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "required": false,
+      "readOnly": true,
+      "role": "groupMemberships",
+      "label": "Mailing lists"
+    }
+  }
+}

package/static/schemas/twake/groups.json

@@ -5,7 +5,15 @@
     "objectClass": ["top", "groupOfNames", "twakeStaticGroup"],
     "singularName": "group",
     "pluralName": "groups",
-    "base": "ou=groups,__ldap_base__"
+    "base": "ou=groups,__ldap_base__",
+    "label": {
+      "en": "Groups",
+      "fr": "Groupes"
+    },
+    "singularLabel": {
+      "en": "group",
+      "fr": "groupe"
+    }
   },
   "strict": true,
   "attributes": {
@@ -21,55 +29,113 @@
     },
     "cn": {
       "type": "string",
-      "test": "^[a-zA-Z][a-zA-Z0-9-]{0,254}$",
+      "searchable": true,
+      "test": "^(?!.*\\.\\.)[a-zA-Z0-9!#$%&'*+/=?^_`{|}.-]{1,64}$",
+      "hint": "Must match an email local part: letters, digits and ! # $ % & ' * + / = ? ^ _ ` { | } . -, no consecutive dots",
       "required": true,
-      "role": "identifier"
+      "role": "identifier",
+      "label": {
+        "en": "Name",
+        "fr": "Nom"
+      }
     },
     "description": {
       "type": "string",
-      "required": false
+      "searchable": true,
+      "required": false,
+      "label": {
+        "en": "Description",
+        "fr": "Description"
+      }
     },
     "mail": {
       "type": "string",
+      "searchable": true,
       "test": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$",
+      "hint": "Expected an email address, e.g. all-staff@lists.example.org",
       "required": false,
-      "role": "primaryEmail"
+      "unique": {
+        "attributes": ["mailAlternateAddress"],
+        "branches": ["__LDAP_BASE__"]
+      },
+      "mailDomainScope": "organization",
+      "allowSubdomains": true,
+      "role": "primaryEmail",
+      "label": {
+        "en": "Email",
+        "fr": "Adresse électronique"
+      }
+    },
+    "businessCategory": {
+      "type": "pointer",
+      "branch": ["ou=twakeListType,ou=nomenclature,__LDAP_BASE__"],
+      "required": false,
+      "role": "writePolicy",
+      "label": {
+        "en": "List type",
+        "fr": "Type de liste"
+      },
+      "group": "Mailbox Settings"
     },
     "twakeMailboxType": {
       "type": "pointer",
       "branch": ["ou=twakeMailboxType,ou=nomenclature,__LDAP_BASE__"],
       "group": "Mailbox Settings",
-      "required": false
+      "required": false,
+      "role": "mailboxType",
+      "label": {
+        "en": "Group type",
+        "fr": "Type de groupe"
+      }
     },
     "member": {
       "type": "array",
       "items": {
         "type": "string",
-        "test": "^[a-zA-Z]+=.*,__LDAP_BASE__$"
+        "test": "^[a-zA-Z]+=.*,__LDAP_BASE__$",
+        "hint": "Expected the DN of an entry of this directory"
       },
       "required": false,
-      "role": "members"
+      "role": "members",
+      "label": {
+        "en": "Members",
+        "fr": "Membres"
+      }
     },
     "owner": {
       "type": "array",
       "items": {
         "type": "string",
-        "test": "^[a-zA-Z]+=[a-zA-Z][a-zA-Z0-9-]*,__LDAP_BASE__$"
+        "test": "^[a-zA-Z]+=[a-zA-Z][a-zA-Z0-9-]*,__LDAP_BASE__$",
+        "hint": "Expected the DN of an entry of this directory"
       },
       "required": false,
-      "role": "owners"
+      "role": "owners",
+      "label": {
+        "en": "Owners",
+        "fr": "Propriétaires"
+      }
     },
     "twakeDepartmentLink": {
-      "type": "string",
-      "test": "^.*,__LDAP_BASE__",
+      "type": "pointer",
+      "branch": ["__LDAP_BASE__"],
       "required": true,
-      "role": "organizationLink"
+      "role": "organizationLink",
+      "label": {
+        "en": "Department",
+        "fr": "Organisation"
+      }
     },
     "twakeDepartmentPath": {
       "type": "string",
-      "test": "^[\\w\\s/,]+$",
+      "test": "^[^\\r\\n]{1,4096}$",
       "required": true,
-      "role": "organizationPath"
+      "generated": true,
+      "role": "organizationPath",
+      "label": {
+        "en": "Department path",
+        "fr": "Chemin"
+      }
     }
   }
 }