Type Alias IpPoliciesAPI

type IpPoliciesAPI = {
    clearCache: typeof ipPolicies.clearCache;
    createIpPolicy: typeof createIpPolicy;
    deleteIpPolicy: typeof deleteIpPolicy;
    getIpPolicies: typeof getIpPolicies;
    getIpPolicy: typeof getIpPolicy;
    patchIpPolicy: typeof patchIpPolicy;
}
Index

Properties

clearCache: typeof ipPolicies.clearCache

Clears the cache for ip-policies api requests.

createIpPolicy: typeof createIpPolicy

Creates a new IPv4 IP policy in the tenant. If this is the first enabled policy, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the TenantAdmin role. IPv6 IP addresses are not currently supported.

an object with the body content

CreateIpPolicyHttpError

deleteIpPolicy: typeof deleteIpPolicy

Deletes an IP policy by ID. If this is the last enabled policy in the tenant, IP allowlisting will be disabled and access will be permitted via all IP addresses. The user's IP address must be present in at least one other policy if allowlisting is enabled. The user must be assigned the TenantAdmin role.

The unique identifier for the IP policy.

DeleteIpPolicyHttpError

getIpPolicies: typeof getIpPolicies

Returns a list of IP policies present in the tenant. The user must be assigned the TenantAdmin role.

an object with query parameters

GetIpPoliciesHttpError

getIpPolicy: typeof getIpPolicy

Retrieves details for a specific IP policy by policy ID.

The IP policy unique identifier

GetIpPolicyHttpError

patchIpPolicy: typeof patchIpPolicy

Updates the IP policy. If this is the first enabled policy in the tenant, IP allowlisting will be enabled and access via other IP addresses will be blocked. The user's IP address must be present in at least one policy if allowlisting is enabled. The user must be assigned the TenantAdmin role.

The unique identifier for the IP policy.

an object with the body content

PatchIpPolicyHttpError