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

# IOrganization

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

Represents an organization that services analytical workspaces.

**Signature:**

```typescript
export interface IOrganization 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [organizationId](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationorganizationid) | `readonly` | string | ID of organization. |

## Methods

| Method | Description |
| --- | --- |
| [agents()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationagents) | **_(ALPHA)_** Returns service that can be used to query AI agent skills available in the organization. |
| [automations()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationautomations) | **_(ALPHA)_** Returns service that can be used to query and manage automations across all workspaces in the organization for centralized automation management. |
| [cspDirectives()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationcspdirectives) | **_(ALPHA)_** Returns service that can be used to manage Content Security Policy directives of the organization. |
| [exportTemplates()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationexporttemplates) | **_(BETA)_** Returns service that can be used to query organization-level export templates for slide exports. |
| [genAI()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationgenai) | **_(ALPHA)_** Returns service that can be used to query and manage organization-level generative-AI resources. |
| [getDescriptor(includeAdditionalDetails)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationgetdescriptor) | Returns details about the organization. |
| [getPlatformUsage()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationgetplatformusage) | **_(ALPHA)_** Returns current usage of the platform resources that the organization license can limit. |
| [ipAllowlists()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationipallowlists) | **_(ALPHA)_** Returns service that can be used to manage organization-level IP allowlist policies. |
| [llmProviders()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationllmproviders) | Returns service that can be used to query and manage organization LLM providers. |
| [localization()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationlocalization) | **_(ALPHA)_** Returns service that reports how languages and translations are used across the organization. |
| [notificationChannels()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationnotificationchannels) | Returns service that can be used to query and manage organization notification channels. |
| [notifications()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationnotifications) | Returns service that can be used to query and manage organization notifications. |
| [permissions()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationpermissions) | Returns service that can be used to query and manage permissions to organization. |
| [securitySettings()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationsecuritysettings) | Returns service that can be used to query and update organization security settings. |
| [settings()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationsettings) | Returns current organization settings. |
| [styling()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationstyling) | Returns service that can be used to query and update organization styling. |
| [updateDescriptor(descriptor)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationupdatedescriptor) | Updates details about the organization. |
| [users()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganization/index.md#iorganizationusers) | Returns service that can be used to query and update organization users and user groups. |

## Property details

### IOrganization.organizationId

ID of organization.

**Signature:**

```typescript
readonly organizationId: string;
```

## Method details

### IOrganization.agents()

> **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).
> 

Returns service that can be used to query AI agent skills available in the organization.

**Signature:**

```typescript
agents(): IOrganizationAgentsService;
```
**Returns:**

[IOrganizationAgentsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationagentsservice/index.md)

### IOrganization.automations()

> **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).
> 

Returns service that can be used to query and manage automations across all workspaces in the organization for centralized automation management.

**Signature:**

```typescript
automations(): IOrganizationAutomationService;
```
**Returns:**

[IOrganizationAutomationService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationautomationservice/index.md)

### IOrganization.cspDirectives()

> **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).
> 

Returns service that can be used to manage Content Security Policy directives of the organization.

**Signature:**

```typescript
cspDirectives(): IOrganizationCspDirectivesService;
```
**Returns:**

[IOrganizationCspDirectivesService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationcspdirectivesservice/index.md)

### IOrganization.exportTemplates()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Returns service that can be used to query organization-level export templates for slide exports.

**Signature:**

```typescript
exportTemplates(): IOrganizationExportTemplatesService;
```
**Returns:**

[IOrganizationExportTemplatesService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationexporttemplatesservice/index.md)

### IOrganization.genAI()

> **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).
> 

Returns service that can be used to query and manage organization-level generative-AI resources.

**Signature:**

```typescript
genAI(): IOrganizationGenAIService;
```
**Returns:**

[IOrganizationGenAIService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationgenaiservice/index.md)

### IOrganization.getDescriptor()

Returns details about the organization.

**Signature:**

```typescript
getDescriptor(includeAdditionalDetails?: boolean): Promise<IOrganizationDescriptor>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| includeAdditionalDetails | boolean | _(Optional)_ include additional details such as bootstrap user and user group. |

**Returns:**

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

### IOrganization.getPlatformUsage()

> **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).
> 

Returns current usage of the platform resources that the organization license can limit.

**Signature:**

```typescript
getPlatformUsage(): Promise<IPlatformUsage[]>;
```
**Returns:**

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

### IOrganization.ipAllowlists()

> **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).
> 

Returns service that can be used to manage organization-level IP allowlist policies.

**Signature:**

```typescript
ipAllowlists(): IOrganizationIpAllowlistService;
```
**Returns:**

[IOrganizationIpAllowlistService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationipallowlistservice/index.md)

### IOrganization.llmProviders()

Returns service that can be used to query and manage organization LLM providers.

**Signature:**

```typescript
llmProviders(): IOrganizationLlmProvidersService;
```
**Returns:**

[IOrganizationLlmProvidersService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationllmprovidersservice/index.md)

### IOrganization.localization()

> **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).
> 

Returns service that reports how languages and translations are used across the organization.

**Signature:**

```typescript
localization(): IOrganizationLocalizationService;
```
**Returns:**

[IOrganizationLocalizationService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationlocalizationservice/index.md)

### IOrganization.notificationChannels()

Returns service that can be used to query and manage organization notification channels.

**Signature:**

```typescript
notificationChannels(): IOrganizationNotificationChannelService;
```
**Returns:**

[IOrganizationNotificationChannelService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationnotificationchannelservice/index.md)

### IOrganization.notifications()

Returns service that can be used to query and manage organization notifications.

**Signature:**

```typescript
notifications(): IOrganizationNotificationService;
```
**Returns:**

[IOrganizationNotificationService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationnotificationservice/index.md)

### IOrganization.permissions()

Returns service that can be used to query and manage permissions to organization.

**Signature:**

```typescript
permissions(): IOrganizationPermissionService;
```
**Returns:**

[IOrganizationPermissionService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationpermissionservice/index.md)

### IOrganization.securitySettings()

Returns service that can be used to query and update organization security settings.

**Signature:**

```typescript
securitySettings(): ISecuritySettingsService;
```
**Returns:**

[ISecuritySettingsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.isecuritysettingsservice/index.md)

### IOrganization.settings()

Returns current organization settings.

**Signature:**

```typescript
settings(): IOrganizationSettingsService;
```
**Returns:**

[IOrganizationSettingsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationsettingsservice/index.md)

### IOrganization.styling()

Returns service that can be used to query and update organization styling.

**Signature:**

```typescript
styling(): IOrganizationStylingService;
```
**Returns:**

[IOrganizationStylingService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationstylingservice/index.md)

### IOrganization.updateDescriptor()

Updates details about the organization.

**Signature:**

```typescript
updateDescriptor(descriptor: IOrganizationDescriptorUpdate): Promise<IOrganizationDescriptor>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| descriptor | [IOrganizationDescriptorUpdate](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iorganizationdescriptorupdate/index.md) | properties to update |

**Returns:**

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

### IOrganization.users()

Returns service that can be used to query and update organization users and user groups.

**Signature:**

```typescript
users(): IOrganizationUserService;
```
**Returns:**

[IOrganizationUserService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationuserservice/index.md)