> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IOrganizationPermissionService

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/organization/permissions/index.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

This service provides access to organization permissions.

**Signature:**

```typescript
export interface IOrganizationPermissionService 
```

## Methods

| Method | Description |
| --- | --- |
| [assignPermissions(permissionsAsignment)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationpermissionservice/index.md#iorganizationpermissionserviceassignpermissions) | **_(ALPHA)_** Assigns workspace and or data source permissions to list of the assignees. |
| [getOrganizationPermissionForUser(userId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationpermissionservice/index.md#iorganizationpermissionservicegetorganizationpermissionforuser) | **_(ALPHA)_** Get list of organization permissions assigned to the user. |
| [getOrganizationPermissionForUserGroup(userGroupId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationpermissionservice/index.md#iorganizationpermissionservicegetorganizationpermissionforusergroup) | **_(ALPHA)_** Get list of organization permissions assigned to the user group. |
| [getPermissionsForUser(userId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationpermissionservice/index.md#iorganizationpermissionservicegetpermissionsforuser) | **_(ALPHA)_** Get list of assigned workspaces and data sources of the user and their permissions. |
| [getPermissionsForUserGroup(userGroupId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationpermissionservice/index.md#iorganizationpermissionservicegetpermissionsforusergroup) | **_(ALPHA)_** Get list of assigned workspaces and data sources of the user group and their permissions. |
| [revokePermissions(permissionsAsignment)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationpermissionservice/index.md#iorganizationpermissionservicerevokepermissions) | **_(ALPHA)_** Revokes workspace and or data source permissions to list of the assignees. |
| [updateOrganizationPermissions(permissionAssignments)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationpermissionservice/index.md#iorganizationpermissionserviceupdateorganizationpermissions) | **_(ALPHA)_** Update organization permission for the user or user group. |

## Method details

### IOrganizationPermissionService.assignPermissions()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Assigns workspace and or data source permissions to list of the assignees.

**Signature:**

```typescript
assignPermissions(permissionsAsignment: IPermissionsAssignment): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| permissionsAsignment | [IPermissionsAssignment](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ipermissionsassignment/index.md) | specification of the assignees and permissions to be assigned. |

**Returns:**

Promise&lt;void&gt;

promise

### IOrganizationPermissionService.getOrganizationPermissionForUser()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get list of organization permissions assigned to the user.

**Signature:**

```typescript
getOrganizationPermissionForUser(userId: string): Promise<OrganizationPermissionAssignment[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| userId | string | ID of the user. |

**Returns:**

Promise&lt;[OrganizationPermissionAssignment](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.organizationpermissionassignment/index.md)[]&gt;

promise

### IOrganizationPermissionService.getOrganizationPermissionForUserGroup()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get list of organization permissions assigned to the user group.

**Signature:**

```typescript
getOrganizationPermissionForUserGroup(userGroupId: string): Promise<OrganizationPermissionAssignment[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| userGroupId | string | ID of the user. |

**Returns:**

Promise&lt;[OrganizationPermissionAssignment](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.organizationpermissionassignment/index.md)[]&gt;

promise

### IOrganizationPermissionService.getPermissionsForUser()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get list of assigned workspaces and data sources of the user and their permissions.

**Signature:**

```typescript
getPermissionsForUser(userId: string): Promise<{
        workspacePermissions: IWorkspacePermissionAssignment[];
        dataSourcePermissions: IDataSourcePermissionAssignment[];
    }>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| userId | string | ID of the user. |

**Returns:**

Promise&lt;{ workspacePermissions: [IWorkspacePermissionAssignment](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspacepermissionassignment/index.md)[]; dataSourcePermissions: [IDataSourcePermissionAssignment](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcepermissionassignment/index.md)[]; }&gt;

promise

### IOrganizationPermissionService.getPermissionsForUserGroup()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get list of assigned workspaces and data sources of the user group and their permissions.

**Signature:**

```typescript
getPermissionsForUserGroup(userGroupId: string): Promise<{
        workspacePermissions: IWorkspacePermissionAssignment[];
        dataSourcePermissions: IDataSourcePermissionAssignment[];
    }>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| userGroupId | string |  |

**Returns:**

Promise&lt;{ workspacePermissions: [IWorkspacePermissionAssignment](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspacepermissionassignment/index.md)[]; dataSourcePermissions: [IDataSourcePermissionAssignment](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcepermissionassignment/index.md)[]; }&gt;

promise

### IOrganizationPermissionService.revokePermissions()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Revokes workspace and or data source permissions to list of the assignees.

**Signature:**

```typescript
revokePermissions(permissionsAsignment: IPermissionsAssignment): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| permissionsAsignment | [IPermissionsAssignment](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ipermissionsassignment/index.md) | specification of the assignees and permissions to be revoked. |

**Returns:**

Promise&lt;void&gt;

promise

### IOrganizationPermissionService.updateOrganizationPermissions()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Update organization permission for the user or user group.

**Signature:**

```typescript
updateOrganizationPermissions(permissionAssignments: IOrganizationPermissionAssignment[]): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| permissionAssignments | [IOrganizationPermissionAssignment](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iorganizationpermissionassignment/index.md)[] | 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&lt;void&gt;

promise
