IOrganizationPermissionService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
This service provides access to organization permissions.
export interface IOrganizationPermissionService
Methods
Method | Description |
|---|---|
(ALPHA) Assigns workspace and or data source permissions to list of the assignees. | |
(ALPHA) Get list of organization permissions assigned to the user. | |
(ALPHA) Get list of organization permissions assigned to the user group. | |
(ALPHA) Get list of assigned workspaces and data sources of the user and their permissions. | |
(ALPHA) Get list of assigned workspaces and data sources of the user group and their permissions. | |
(ALPHA) Revokes workspace and or data source permissions to list of the assignees. | |
(ALPHA) Update organization permission for the user or user group. |
Method details
IOrganizationPermissionService.assignPermissions()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Assigns workspace and or data source permissions to list of the assignees.
assignPermissions(permissionsAsignment: IPermissionsAssignment): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
permissionsAsignment | specification of the assignees and permissions to be assigned. |
Returns
Promise<void>
promise
IOrganizationPermissionService.getOrganizationPermissionForUser()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get list of organization permissions assigned to the user.
getOrganizationPermissionForUser(userId: string): Promise<OrganizationPermissionAssignment[]>;
Parameters
Parameter | Type | Description |
|---|---|---|
userId | string | ID of the user. |
Returns
Promise<OrganizationPermissionAssignment[]>
promise
IOrganizationPermissionService.getOrganizationPermissionForUserGroup()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get list of organization permissions assigned to the user group.
getOrganizationPermissionForUserGroup(userGroupId: string): Promise<OrganizationPermissionAssignment[]>;
Parameters
Parameter | Type | Description |
|---|---|---|
userGroupId | string | ID of the user. |
Returns
Promise<OrganizationPermissionAssignment[]>
promise
IOrganizationPermissionService.getPermissionsForUser()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get list of assigned workspaces and data sources of the user and their permissions.
getPermissionsForUser(userId: string): Promise<{
workspacePermissions: IWorkspacePermissionAssignment[];
dataSourcePermissions: IDataSourcePermissionAssignment[];
}>;
Parameters
Parameter | Type | Description |
|---|---|---|
userId | string | ID of the user. |
Returns
Promise<{ workspacePermissions: IWorkspacePermissionAssignment[]; dataSourcePermissions: IDataSourcePermissionAssignment[]; }>
promise
IOrganizationPermissionService.getPermissionsForUserGroup()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get list of assigned workspaces and data sources of the user group and their permissions.
getPermissionsForUserGroup(userGroupId: string): Promise<{
workspacePermissions: IWorkspacePermissionAssignment[];
dataSourcePermissions: IDataSourcePermissionAssignment[];
}>;
Parameters
Parameter | Type | Description |
|---|---|---|
userGroupId | string |
Returns
Promise<{ workspacePermissions: IWorkspacePermissionAssignment[]; dataSourcePermissions: IDataSourcePermissionAssignment[]; }>
promise
IOrganizationPermissionService.revokePermissions()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Revokes workspace and or data source permissions to list of the assignees.
revokePermissions(permissionsAsignment: IPermissionsAssignment): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
permissionsAsignment | specification of the assignees and permissions to be revoked. |
Returns
Promise<void>
promise
IOrganizationPermissionService.updateOrganizationPermissions()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Update organization permission for the user or user group.
updateOrganizationPermissions(permissionAssignments: IOrganizationPermissionAssignment[]): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
permissionAssignments | new sets of permission assignments to the organization. Set permissions property for assignee to an empty array to remove the user’s permissions. |
Returns
Promise<void>
promise