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

# IOrganizationIpAllowlistService

- 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/ipAllowlists/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).
> 

Service for managing organization-level IP allowlist policies.

**Signature:**

```typescript
export interface IOrganizationIpAllowlistService 
```

## Methods

| Method | Description |
| --- | --- |
| [create(definition)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationipallowlistservice/index.md#iorganizationipallowlistservicecreate) | **_(ALPHA)_** Create a new IP allowlist policy. |
| [delete(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationipallowlistservice/index.md#iorganizationipallowlistservicedelete) | **_(ALPHA)_** Delete an IP allowlist policy by its identifier. |
| [getAll()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationipallowlistservice/index.md#iorganizationipallowlistservicegetall) | **_(ALPHA)_** Get all IP allowlist policies defined for the organization. |
| [update(definition)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationipallowlistservice/index.md#iorganizationipallowlistserviceupdate) | **_(ALPHA)_** Replace an existing IP allowlist policy (PUT semantics). |

## Method details

### IOrganizationIpAllowlistService.create()

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

Create a new IP allowlist policy.

**Signature:**

```typescript
create(definition: IIpAllowlistDefinition): Promise<IIpAllowlist>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| definition | [IIpAllowlistDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iipallowlistdefinition/index.md) | definition of the policy to create |

**Returns:**

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

Promise resolved with the created policy.

### IOrganizationIpAllowlistService.delete()

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

Delete an IP allowlist policy by its identifier.

**Signature:**

```typescript
delete(id: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | identifier of the policy to delete |

**Returns:**

Promise&lt;void&gt;

### IOrganizationIpAllowlistService.getAll()

> **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 all IP allowlist policies defined for the organization.

**Signature:**

```typescript
getAll(): Promise<IIpAllowlist[]>;
```
**Returns:**

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

Promise resolved with an array of policies (empty when none exist).

### IOrganizationIpAllowlistService.update()

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

Replace an existing IP allowlist policy (PUT semantics).

**Signature:**

```typescript
update(definition: IIpAllowlistDefinition): Promise<IIpAllowlist>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| definition | [IIpAllowlistDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iipallowlistdefinition/index.md) | full definition of the policy; `id` identifies the target |

**Returns:**

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

Promise resolved with the updated policy.