Interface UserEntitlements

Entitlements of the user.

interface UserEntitlements {
    entitlements: Entitlement[];
    entitlementsSetName?: string;
    version: number;
}

Properties

entitlements entitlementsSetName? version

Properties

entitlements

entitlements: Entitlement[]

The full set of entitlements assigned to the user.

Optional entitlementsSetName

entitlementsSetName?: string

Name of the entitlement set assigned to the user or undefined if the user's entitlements are assigned directly.

version

version: number

Version number of the user's entitlements. This is incremented every time there is a change of entitlements set or explicit entitlements for this user.

For users entitled by entitlement set, the fractional part of this version specifies the version of the entitlements set itself divided by 100000 (specified by [[entitlementsSetVersionScalingFactor]]).

See also:

  • [[entitlementsSetVersionScalingFactor]]
  • [[splitUserEntitlementsVersion]]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc