IIpAllowlistDefinition
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Definition used to create an organization IP allowlist policy.
export interface IIpAllowlistDefinition
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string[] | (ALPHA) IPv4 or IPv6 addresses and/or CIDR ranges allowed by the policy. The | ||
string | (ALPHA) Client-assigned identifier. Must be unique within the organization. | ||
string[] | (ALPHA) Identifiers of user groups to which the policy applies. | ||
string[] | (ALPHA) Identifiers of users to which the policy applies. |
Property details
IIpAllowlistDefinition.allowedSourcespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
IPv4 or IPv6 addresses and/or CIDR ranges allowed by the policy. The /0 prefix (matching the entire address space) is rejected by the backend.
allowedSources: string[];
IIpAllowlistDefinition.idpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Client-assigned identifier. Must be unique within the organization.
id: string;
IIpAllowlistDefinition.userGroupIdspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Identifiers of user groups to which the policy applies.
userGroupIds: string[];
IIpAllowlistDefinition.userIdspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Identifiers of users to which the policy applies.
userIds: string[];