IOrganizationIpAllowlistService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Service for managing organization-level IP allowlist policies.
export interface IOrganizationIpAllowlistService
Methods
Method | Description |
|---|---|
(ALPHA) Create a new IP allowlist policy. | |
(ALPHA) Delete an IP allowlist policy by its identifier. | |
(ALPHA) Get all IP allowlist policies defined for the organization. | |
(ALPHA) Replace an existing IP allowlist policy (PUT semantics). |
Method details
IOrganizationIpAllowlistService.create()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Create a new IP allowlist policy.
create(definition: IIpAllowlistDefinition): Promise<IIpAllowlist>;
Parameters
Parameter | Type | Description |
|---|---|---|
definition | definition of the policy to create |
Returns
Promise<IIpAllowlist>
Promise resolved with the created policy.
IOrganizationIpAllowlistService.delete()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Delete an IP allowlist policy by its identifier.
delete(id: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
id | string | identifier of the policy to delete |
Returns
Promise<void>
IOrganizationIpAllowlistService.getAll()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Get all IP allowlist policies defined for the organization.
getAll(): Promise<IIpAllowlist[]>;
Returns
Promise<IIpAllowlist[]>
Promise resolved with an array of policies (empty when none exist).
IOrganizationIpAllowlistService.update()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Replace an existing IP allowlist policy (PUT semantics).
update(definition: IIpAllowlistDefinition): Promise<IIpAllowlist>;
Parameters
Parameter | Type | Description |
|---|---|---|
definition | full definition of the policy; |
Returns
Promise<IIpAllowlist>
Promise resolved with the updated policy.