DirXML-EntitlementRef is used to indicate the assignment of an DirXML Entitlement on a recipient.

The DirXML-EntitlementRef NameSpaceType Field indicates if the DirXML Entitlement is Granted or Revoked.

Attribute Definition#

The DirXML-EntitlementRef AttributeTypes is defined as:


DirXML-EntitlementRef Remarks#

The VolumeName Field (or DN) portion of the path syntax value refers to the DirXML-Entitlement object.

Because the attribute is Write-managed, the agent setting the DirXML-EntitlementRef attribute value on an eDirectory object must have write access to the DirXML-EntitlementRef attribute on the object that is being written to and must also have write access to the ACL attribute on the DirXML-Entitlement object that is referred to by the DN portion of the DirXML-EntitlementRef value.

The Path Field (or string) portion of the DirXML-EntitlementRef attribute contains an XML document whose root element is <ref>.

The NameSpaceType Field (or integer) portion of the DirXML-EntitlementRef attribute is used as a Bitmask to hold a set of flags.

Bit 0 of the 32-bit integer is used for this flag value and is known as the state bit where:

  • 0 means revoked
  • 1 means granted

Bit 1 is used to flag a granted entitlement that is the result of the upgrade process and is known as the upgrade bit where:

  • 1 means that the entitlement was previously granted in the legacy format and is therefore not a change in the entitlement state.

Bits 2-31 are reserved for future use.

More Information#

There might be more information for this subject on one of the following: