IAccessControlAware
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Common properties for objects with controlled access
export interface IAccessControlAware
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| boolean | (ALPHA) (Optional) When object is locked, no one other than the administrator can edit it | |
| boolean | (ALPHA) (Optional) For backends NOT forcing strict access this prop reflects its current setting of strict access If set to true then object is not accessible via its URI for people without access rights. Otherwise object is accessible by its URI, eg. when drilling to it. | |
| (ALPHA) (Optional) Dashboard share permissions | ||
| (ALPHA) Current object share status. This prop is affecting listing of object and access to it for different users |
Property details
IAccessControlAware.isLockedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
When object is locked, no one other than the administrator can edit it
readonly isLocked?: boolean;
IAccessControlAware.isUnderStrictControlpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
For backends NOT forcing strict access this prop reflects its current setting of strict access If set to true then object is not accessible via its URI for people without access rights. Otherwise object is accessible by its URI, eg. when drilling to it.
readonly isUnderStrictControl?: boolean;
IAccessControlAware.sharePermissionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard share permissions
readonly sharePermissions?: SharePermission[];
IAccessControlAware.shareStatuspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Current object share status. This prop is affecting listing of object and access to it for different users
readonly shareStatus: ShareStatus;