IWorkspaceAccessControlService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Service to manage access to the objects.
export interface IWorkspaceAccessControlService
Methods
Method | Description |
|---|---|
(ALPHA) Function that allows to change access (add, edit, revoke) to an object for multiple grantees. If the grantee permissions array is empty, the access is revoked. Otherwise, it is set to the permissions in the array. If backend does not support granular permissions, the array content is used only to check if access should be granted or revoked. | |
(ALPHA) | |
(ALPHA) Get list of available grantees for the shared object. | |
(ALPHA) | |
(ALPHA) |
Method details
IWorkspaceAccessControlService.changeAccess()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Function that allows to change access (add, edit, revoke) to an object for multiple grantees. If the grantee permissions array is empty, the access is revoked. Otherwise, it is set to the permissions in the array.
If backend does not support granular permissions, the array content is used only to check if access should be granted or revoked.
changeAccess(sharedObject: ObjRef, grantees: IGranularAccessGrantee[]): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
sharedObject | the ref of object that will have access changed | |
grantees | list of grantees that will have access changed for the shared object |
Returns
Promise<void>
IWorkspaceAccessControlService.getAccessList()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
getAccessList(sharedObject: ObjRef): Promise<AccessGranteeDetail[]>;
Parameters
Parameter | Type | Description |
|---|---|---|
sharedObject |
Returns
Promise<AccessGranteeDetail[]>
IWorkspaceAccessControlService.getAvailableGrantees()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get list of available grantees for the shared object.
getAvailableGrantees(sharedObject: ObjRef, search?: string): Promise<IAvailableAccessGrantee[]>;
Parameters
Parameter | Type | Description |
|---|---|---|
sharedObject | the ref of object that will have access changed | |
search | string | (Optional) optional string used to limit the results (matched against name of user group, or first name, last name, or email of user). |
Returns
Promise<IAvailableAccessGrantee[]>
IWorkspaceAccessControlService.grantAccess()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
grantAccess(sharedObject: ObjRef, grantees: IAccessGrantee[]): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
sharedObject | ||
grantees |
Returns
Promise<void>
IWorkspaceAccessControlService.revokeAccess()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
revokeAccess(sharedObject: ObjRef, grantees: IAccessGrantee[]): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
sharedObject | ||
grantees |
Returns
Promise<void>