changeAccess()

Home > @gooddata/sdk-backend-spi > IWorkspaceAccessControlService > changeAccess

IWorkspaceAccessControlService.changeAccess() method

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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.

Signature:

changeAccess(sharedObject: ObjRef, grantees: IGranularAccessGrantee[]): Promise<void>;

Parameters

Parameter	Type	Description
sharedObject	ObjRef	the ref of object that will have access changed
grantees	IGranularAccessGrantee[]	list of grantees that will have access changed for the shared object

Returns:

Promise<void>