api.md

ZeroTrust

Devices

Types:

• Device
• DeviceGetResponse

Methods:

• client.zeroTrust.devices.list({ ...params }) -> DevicesSinglePage
• client.zeroTrust.devices.get(deviceId, { ...params }) -> DeviceGetResponse | null

Devices

Types:

• DeviceListResponse
• DeviceDeleteResponse
• DeviceGetResponse
• DeviceRevokeResponse

Methods:

• client.zeroTrust.devices.devices.list({ ...params }) -> DeviceListResponsesCursorPagination
• client.zeroTrust.devices.devices.delete(deviceId, { ...params }) -> DeviceDeleteResponse | null
• client.zeroTrust.devices.devices.get(deviceId, { ...params }) -> DeviceGetResponse
• client.zeroTrust.devices.devices.revoke(deviceId, { ...params }) -> DeviceRevokeResponse | null

Resilience

GlobalWARPOverride

Types:

• GlobalWARPOverrideCreateResponse
• GlobalWARPOverrideGetResponse

Methods:

• client.zeroTrust.devices.resilience.globalWARPOverride.create({ ...params }) -> GlobalWARPOverrideCreateResponse | null
• client.zeroTrust.devices.resilience.globalWARPOverride.get({ ...params }) -> GlobalWARPOverrideGetResponse | null

Registrations

Types:

• RegistrationListResponse
• RegistrationDeleteResponse
• RegistrationBulkDeleteResponse
• RegistrationGetResponse
• RegistrationRevokeResponse
• RegistrationUnrevokeResponse

Methods:

• client.zeroTrust.devices.registrations.list({ ...params }) -> RegistrationListResponsesCursorPagination
• client.zeroTrust.devices.registrations.delete(registrationId, { ...params }) -> RegistrationDeleteResponse | null
• client.zeroTrust.devices.registrations.bulkDelete({ ...params }) -> RegistrationBulkDeleteResponse | null
• client.zeroTrust.devices.registrations.get(registrationId, { ...params }) -> RegistrationGetResponse
• client.zeroTrust.devices.registrations.revoke({ ...params }) -> RegistrationRevokeResponse | null
• client.zeroTrust.devices.registrations.unrevoke({ ...params }) -> RegistrationUnrevokeResponse | null

DEXTests

Types:

• SchemaData
• SchemaHTTP
• DEXTestCreateResponse
• DEXTestUpdateResponse
• DEXTestListResponse
• DEXTestDeleteResponse
• DEXTestGetResponse

Methods:

• client.zeroTrust.devices.dexTests.create({ ...params }) -> DEXTestCreateResponse
• client.zeroTrust.devices.dexTests.update(dexTestId, { ...params }) -> DEXTestUpdateResponse
• client.zeroTrust.devices.dexTests.list({ ...params }) -> DEXTestListResponsesV4PagePaginationArray
• client.zeroTrust.devices.dexTests.delete(dexTestId, { ...params }) -> DEXTestDeleteResponse
• client.zeroTrust.devices.dexTests.get(dexTestId, { ...params }) -> DEXTestGetResponse

IPProfiles

Types:

• IPProfile
• IPProfileDeleteResponse

Methods:

• client.zeroTrust.devices.ipProfiles.create({ ...params }) -> IPProfile
• client.zeroTrust.devices.ipProfiles.update(profileId, { ...params }) -> IPProfile
• client.zeroTrust.devices.ipProfiles.list({ ...params }) -> IPProfilesSinglePage
• client.zeroTrust.devices.ipProfiles.delete(profileId, { ...params }) -> IPProfileDeleteResponse
• client.zeroTrust.devices.ipProfiles.get(profileId, { ...params }) -> IPProfile

DeploymentGroups

Types:

• DeploymentGroup
• DeploymentGroupDeleteResponse

Methods:

• client.zeroTrust.devices.deploymentGroups.create({ ...params }) -> DeploymentGroup
• client.zeroTrust.devices.deploymentGroups.list({ ...params }) -> DeploymentGroupsV4PagePaginationArray
• client.zeroTrust.devices.deploymentGroups.delete(groupId, { ...params }) -> DeploymentGroupDeleteResponse
• client.zeroTrust.devices.deploymentGroups.edit(groupId, { ...params }) -> DeploymentGroup
• client.zeroTrust.devices.deploymentGroups.get(groupId, { ...params }) -> DeploymentGroup

Networks

Types:

• DeviceNetwork

Methods:

• client.zeroTrust.devices.networks.create({ ...params }) -> DeviceNetwork | null
• client.zeroTrust.devices.networks.update(networkId, { ...params }) -> DeviceNetwork | null
• client.zeroTrust.devices.networks.list({ ...params }) -> DeviceNetworksSinglePage
• client.zeroTrust.devices.networks.delete(networkId, { ...params }) -> DeviceNetworksSinglePage
• client.zeroTrust.devices.networks.get(networkId, { ...params }) -> DeviceNetwork | null

FleetStatus

Types:

• FleetStatusGetResponse

Methods:

• client.zeroTrust.devices.fleetStatus.get(deviceId, { ...params }) -> FleetStatusGetResponse

Policies

Types:

• DevicePolicyCertificates
• FallbackDomain
• FallbackDomainPolicy
• SettingsPolicy
• SplitTunnelExclude
• SplitTunnelInclude

Default

Types:

• DefaultEditResponse
• DefaultGetResponse

Methods:

• client.zeroTrust.devices.policies.default.edit({ ...params }) -> DefaultEditResponse | null
• client.zeroTrust.devices.policies.default.get({ ...params }) -> DefaultGetResponse | null

Excludes

Methods:

• client.zeroTrust.devices.policies.default.excludes.update([ ...body ]) -> SplitTunnelExcludesSinglePage
• client.zeroTrust.devices.policies.default.excludes.get({ ...params }) -> SplitTunnelExcludesSinglePage

Includes

Methods:

• client.zeroTrust.devices.policies.default.includes.update([ ...body ]) -> SplitTunnelIncludesSinglePage
• client.zeroTrust.devices.policies.default.includes.get({ ...params }) -> SplitTunnelIncludesSinglePage

FallbackDomains

Methods:

• client.zeroTrust.devices.policies.default.fallbackDomains.update([ ...domains ]) -> FallbackDomainsSinglePage
• client.zeroTrust.devices.policies.default.fallbackDomains.get({ ...params }) -> FallbackDomainsSinglePage

Certificates

Methods:

• client.zeroTrust.devices.policies.default.certificates.edit({ ...params }) -> DevicePolicyCertificates | null
• client.zeroTrust.devices.policies.default.certificates.get({ ...params }) -> DevicePolicyCertificates | null

Custom

Methods:

• client.zeroTrust.devices.policies.custom.create({ ...params }) -> SettingsPolicy | null
• client.zeroTrust.devices.policies.custom.list({ ...params }) -> SettingsPoliciesSinglePage
• client.zeroTrust.devices.policies.custom.delete(policyId, { ...params }) -> SettingsPoliciesSinglePage
• client.zeroTrust.devices.policies.custom.edit(policyId, { ...params }) -> SettingsPolicy | null
• client.zeroTrust.devices.policies.custom.get(policyId, { ...params }) -> SettingsPolicy | null

Excludes

Methods:

• client.zeroTrust.devices.policies.custom.excludes.update(policyId, [ ...body ]) -> SplitTunnelExcludesSinglePage
• client.zeroTrust.devices.policies.custom.excludes.get(policyId, { ...params }) -> SplitTunnelExcludesSinglePage

Includes

Methods:

• client.zeroTrust.devices.policies.custom.includes.update(policyId, [ ...body ]) -> SplitTunnelIncludesSinglePage
• client.zeroTrust.devices.policies.custom.includes.get(policyId, { ...params }) -> SplitTunnelIncludesSinglePage

FallbackDomains

Methods:

• client.zeroTrust.devices.policies.custom.fallbackDomains.update(policyId, [ ...domains ]) -> FallbackDomainsSinglePage
• client.zeroTrust.devices.policies.custom.fallbackDomains.get(policyId, { ...params }) -> FallbackDomainsSinglePage

Posture

Types:

• CarbonblackInput
• ClientCertificateInput
• CrowdstrikeInput
• DeviceInput
• DeviceMatch
• DevicePostureRule
• DiskEncryptionInput
• DomainJoinedInput
• FileInput
• FirewallInput
• IntuneInput
• KolideInput
• OSVersionInput
• SentineloneInput
• SentineloneS2sInput
• TaniumInput
• UniqueClientIDInput
• WorkspaceOneInput
• PostureDeleteResponse

Methods:

• client.zeroTrust.devices.posture.create({ ...params }) -> DevicePostureRule | null
• client.zeroTrust.devices.posture.update(ruleId, { ...params }) -> DevicePostureRule | null
• client.zeroTrust.devices.posture.list({ ...params }) -> DevicePostureRulesSinglePage
• client.zeroTrust.devices.posture.delete(ruleId, { ...params }) -> PostureDeleteResponse | null
• client.zeroTrust.devices.posture.get(ruleId, { ...params }) -> DevicePostureRule | null

Integrations

Types:

• Integration
• IntegrationDeleteResponse

Methods:

• client.zeroTrust.devices.posture.integrations.create({ ...params }) -> Integration | null
• client.zeroTrust.devices.posture.integrations.list({ ...params }) -> IntegrationsSinglePage
• client.zeroTrust.devices.posture.integrations.delete(integrationId, { ...params }) -> IntegrationDeleteResponse | null
• client.zeroTrust.devices.posture.integrations.edit(integrationId, { ...params }) -> Integration | null
• client.zeroTrust.devices.posture.integrations.get(integrationId, { ...params }) -> Integration | null

Revoke

Types:

• RevokeCreateResponse

Methods:

• client.zeroTrust.devices.revoke.create([ ...body ]) -> RevokeCreateResponse | null

Settings

Types:

• DeviceSettings

Methods:

• client.zeroTrust.devices.settings.update({ ...params }) -> DeviceSettings | null
• client.zeroTrust.devices.settings.delete({ ...params }) -> DeviceSettings | null
• client.zeroTrust.devices.settings.edit({ ...params }) -> DeviceSettings | null
• client.zeroTrust.devices.settings.get({ ...params }) -> DeviceSettings | null

Unrevoke

Types:

• UnrevokeCreateResponse

Methods:

• client.zeroTrust.devices.unrevoke.create([ ...body ]) -> UnrevokeCreateResponse | null

OverrideCodes

Types:

• OverrideCodeListResponse
• OverrideCodeGetResponse

Methods:

• client.zeroTrust.devices.overrideCodes.list(deviceId, { ...params }) -> OverrideCodeListResponsesSinglePage
• client.zeroTrust.devices.overrideCodes.get(registrationId, { ...params }) -> OverrideCodeGetResponse

IdentityProviders

Types:

• AzureAD
• GenericOAuthConfig
• IdentityProvider
• IdentityProviderSCIMConfig
• IdentityProviderType
• IdentityProviderListResponse
• IdentityProviderDeleteResponse

Methods:

• client.zeroTrust.identityProviders.create({ ...params }) -> IdentityProvider
• client.zeroTrust.identityProviders.update(identityProviderId, { ...params }) -> IdentityProvider
• client.zeroTrust.identityProviders.list({ ...params }) -> IdentityProviderListResponsesV4PagePaginationArray
• client.zeroTrust.identityProviders.delete(identityProviderId, { ...params }) -> IdentityProviderDeleteResponse
• client.zeroTrust.identityProviders.get(identityProviderId, { ...params }) -> IdentityProvider

SCIM

Groups

Methods:

• client.zeroTrust.identityProviders.scim.groups.list(identityProviderId, { ...params }) -> ZeroTrustGroupsV4PagePaginationArray

Users

Methods:

• client.zeroTrust.identityProviders.scim.users.list(identityProviderId, { ...params }) -> AccessUsersV4PagePaginationArray

SAMLCertificate

Types:

• SAMLCertificateCreateResponse

Methods:

• client.zeroTrust.identityProviders.samlCertificate.create(identityProviderId, { ...params }) -> SAMLCertificateCreateResponse

Organizations

Types:

• LoginDesign
• Organization
• OrganizationRevokeUsersResponse

Methods:

• client.zeroTrust.organizations.create({ ...params }) -> Organization
• client.zeroTrust.organizations.update({ ...params }) -> Organization
• client.zeroTrust.organizations.list({ ...params }) -> Organization
• client.zeroTrust.organizations.revokeUsers({ ...params }) -> OrganizationRevokeUsersResponse

DOH

Types:

• DOHUpdateResponse
• DOHGetResponse

Methods:

• client.zeroTrust.organizations.doh.update({ ...params }) -> DOHUpdateResponse
• client.zeroTrust.organizations.doh.get({ ...params }) -> DOHGetResponse

Seats

Types:

• Seat

Methods:

• client.zeroTrust.seats.edit([ ...body ]) -> SeatsSinglePage

Access

AIControls

Mcp

Portals

Types:

• PortalCreateResponse
• PortalUpdateResponse
• PortalListResponse
• PortalDeleteResponse
• PortalReadResponse

Methods:

• client.zeroTrust.access.aiControls.mcp.portals.create({ ...params }) -> PortalCreateResponse
• client.zeroTrust.access.aiControls.mcp.portals.update(id, { ...params }) -> PortalUpdateResponse
• client.zeroTrust.access.aiControls.mcp.portals.list({ ...params }) -> PortalListResponsesV4PagePaginationArray
• client.zeroTrust.access.aiControls.mcp.portals.delete(id, { ...params }) -> PortalDeleteResponse
• client.zeroTrust.access.aiControls.mcp.portals.read(id, { ...params }) -> PortalReadResponse

Servers

Types:

• ServerCreateResponse
• ServerUpdateResponse
• ServerListResponse
• ServerDeleteResponse
• ServerReadResponse
• ServerSyncResponse

Methods:

• client.zeroTrust.access.aiControls.mcp.servers.create({ ...params }) -> ServerCreateResponse
• client.zeroTrust.access.aiControls.mcp.servers.update(id, { ...params }) -> ServerUpdateResponse
• client.zeroTrust.access.aiControls.mcp.servers.list({ ...params }) -> ServerListResponsesV4PagePaginationArray
• client.zeroTrust.access.aiControls.mcp.servers.delete(id, { ...params }) -> ServerDeleteResponse
• client.zeroTrust.access.aiControls.mcp.servers.read(id, { ...params }) -> ServerReadResponse
• client.zeroTrust.access.aiControls.mcp.servers.sync(id, { ...params }) -> ServerSyncResponse

GatewayCA

Types:

• GatewayCACreateResponse
• GatewayCAListResponse
• GatewayCADeleteResponse

Methods:

• client.zeroTrust.access.gatewayCA.create({ ...params }) -> GatewayCACreateResponse
• client.zeroTrust.access.gatewayCA.list({ ...params }) -> GatewayCAListResponsesSinglePage
• client.zeroTrust.access.gatewayCA.delete(certificateId, { ...params }) -> GatewayCADeleteResponse

IdPFederationGrants

Types:

• IdPFederationGrant
• IdPFederationGrantListResponse
• IdPFederationGrantDeleteResponse

Methods:

• client.zeroTrust.access.IdPFederationGrants.create({ ...params }) -> IdPFederationGrant
• client.zeroTrust.access.IdPFederationGrants.list({ ...params }) -> IdPFederationGrantListResponse
• client.zeroTrust.access.IdPFederationGrants.delete(grantId, { ...params }) -> IdPFederationGrantDeleteResponse
• client.zeroTrust.access.IdPFederationGrants.get(grantId, { ...params }) -> IdPFederationGrant

SAMLCertificates

Types:

• SAMLCertificateListResponse
• SAMLCertificateGetResponse
• SAMLCertificateRotateResponse

Methods:

• client.zeroTrust.access.samlCertificates.list({ ...params }) -> SAMLCertificateListResponsesV4PagePaginationArray
• client.zeroTrust.access.samlCertificates.get(samlCERTSetId, { ...params }) -> SAMLCertificateGetResponse
• client.zeroTrust.access.samlCertificates.getPem(samlCERTSetId, { ...params }) -> Response
• client.zeroTrust.access.samlCertificates.rotate(samlCERTSetId, { ...params }) -> SAMLCertificateRotateResponse

Infrastructure

Targets

Types:

• TargetCreateResponse
• TargetUpdateResponse
• TargetListResponse
• TargetBulkUpdateResponse
• TargetGetResponse

Methods:

• client.zeroTrust.access.infrastructure.targets.create({ ...params }) -> TargetCreateResponse
• client.zeroTrust.access.infrastructure.targets.update(targetId, { ...params }) -> TargetUpdateResponse
• client.zeroTrust.access.infrastructure.targets.list({ ...params }) -> TargetListResponsesV4PagePaginationArray
• client.zeroTrust.access.infrastructure.targets.delete(targetId, { ...params }) -> void
• client.zeroTrust.access.infrastructure.targets.bulkDelete({ ...params }) -> void
• client.zeroTrust.access.infrastructure.targets.bulkDeleteV2({ ...params }) -> void
• client.zeroTrust.access.infrastructure.targets.bulkUpdate([ ...body ]) -> TargetBulkUpdateResponsesSinglePage
• client.zeroTrust.access.infrastructure.targets.get(targetId, { ...params }) -> TargetGetResponse

Applications

Types:

• AllowedHeaders
• AllowedIdPs
• AllowedMethods
• AllowedOrigins
• AppID
• Application
• ApplicationPolicy
• ApplicationSCIMConfig
• ApplicationType
• CORSHeaders
• Decision
• OIDCSaaSApp
• SaaSAppNameIDFormat
• SAMLSaaSApp
• SCIMConfigAuthenticationHTTPBasic
• SCIMConfigAuthenticationOAuthBearerToken
• SCIMConfigAuthenticationOauth2
• SCIMConfigMapping
• SelfHostedDomains
• ApplicationCreateResponse
• ApplicationUpdateResponse
• ApplicationListResponse
• ApplicationDeleteResponse
• ApplicationGetResponse
• ApplicationRevokeTokensResponse

Methods:

• client.zeroTrust.access.applications.create({ ...params }) -> ApplicationCreateResponse
• client.zeroTrust.access.applications.update(appId, { ...params }) -> ApplicationUpdateResponse
• client.zeroTrust.access.applications.list({ ...params }) -> ApplicationListResponsesV4PagePaginationArray
• client.zeroTrust.access.applications.delete(appId, { ...params }) -> ApplicationDeleteResponse
• client.zeroTrust.access.applications.get(appId, { ...params }) -> ApplicationGetResponse
• client.zeroTrust.access.applications.revokeTokens(appId, { ...params }) -> ApplicationRevokeTokensResponse | null

CAs

Types:

• CA
• CADeleteResponse

Methods:

• client.zeroTrust.access.applications.cas.create(appId, { ...params }) -> CA
• client.zeroTrust.access.applications.cas.list({ ...params }) -> CAsV4PagePaginationArray
• client.zeroTrust.access.applications.cas.delete(appId, { ...params }) -> CADeleteResponse
• client.zeroTrust.access.applications.cas.get(appId, { ...params }) -> CA

UserPolicyChecks

Types:

• UserPolicyCheckGeo
• UserPolicyCheckListResponse

Methods:

• client.zeroTrust.access.applications.userPolicyChecks.list(appId, { ...params }) -> UserPolicyCheckListResponse

Policies

Types:

• AccessDevicePostureRule
• AccessRule
• AnyValidServiceTokenRule
• AuthenticationMethodRule
• AzureGroupRule
• CertificateRule
• CountryRule
• DomainRule
• EmailListRule
• EmailRule
• EveryoneRule
• ExternalEvaluationRule
• GitHubOrganizationRule
• GroupRule
• GSuiteGroupRule
• IPListRule
• IPRule
• OktaGroupRule
• SAMLGroupRule
• ServiceTokenRule
• PolicyCreateResponse
• PolicyUpdateResponse
• PolicyListResponse
• PolicyDeleteResponse
• PolicyGetResponse

Methods:

• client.zeroTrust.access.applications.policies.create(appId, { ...params }) -> PolicyCreateResponse
• client.zeroTrust.access.applications.policies.update(appId, policyId, { ...params }) -> PolicyUpdateResponse
• client.zeroTrust.access.applications.policies.list(appId, { ...params }) -> PolicyListResponsesV4PagePaginationArray
• client.zeroTrust.access.applications.policies.delete(appId, policyId, { ...params }) -> PolicyDeleteResponse
• client.zeroTrust.access.applications.policies.get(appId, policyId, { ...params }) -> PolicyGetResponse

PolicyTests

Types:

• PolicyTestCreateResponse
• PolicyTestGetResponse

Methods:

• client.zeroTrust.access.applications.policyTests.create({ ...params }) -> PolicyTestCreateResponse
• client.zeroTrust.access.applications.policyTests.get(policyTestId, { ...params }) -> PolicyTestGetResponse

Users

Types:

• UserListResponse

Methods:

• client.zeroTrust.access.applications.policyTests.users.list(policyTestId, { ...params }) -> UserListResponsesV4PagePaginationArray

Settings

Types:

• SettingUpdateResponse
• SettingEditResponse

Methods:

• client.zeroTrust.access.applications.settings.update(appId, { ...params }) -> SettingUpdateResponse
• client.zeroTrust.access.applications.settings.edit(appId, { ...params }) -> SettingEditResponse

Certificates

Types:

• AssociatedHostnames
• Certificate
• CertificateDeleteResponse

Methods:

• client.zeroTrust.access.certificates.create({ ...params }) -> Certificate
• client.zeroTrust.access.certificates.update(certificateId, { ...params }) -> Certificate
• client.zeroTrust.access.certificates.list({ ...params }) -> CertificatesV4PagePaginationArray
• client.zeroTrust.access.certificates.delete(certificateId, { ...params }) -> CertificateDeleteResponse
• client.zeroTrust.access.certificates.get(certificateId, { ...params }) -> Certificate

Settings

Types:

• CertificateSettings

Methods:

• client.zeroTrust.access.certificates.settings.update({ ...params }) -> CertificateSettingsSinglePage
• client.zeroTrust.access.certificates.settings.get({ ...params }) -> CertificateSettingsSinglePage

Groups

Types:

• ZeroTrustGroup
• GroupCreateResponse
• GroupUpdateResponse
• GroupListResponse
• GroupDeleteResponse
• GroupGetResponse

Methods:

• client.zeroTrust.access.groups.create({ ...params }) -> GroupCreateResponse
• client.zeroTrust.access.groups.update(groupId, { ...params }) -> GroupUpdateResponse
• client.zeroTrust.access.groups.list({ ...params }) -> GroupListResponsesV4PagePaginationArray
• client.zeroTrust.access.groups.delete(groupId, { ...params }) -> GroupDeleteResponse
• client.zeroTrust.access.groups.get(groupId, { ...params }) -> GroupGetResponse

ServiceTokens

Types:

• ServiceToken
• ServiceTokenCreateResponse
• ServiceTokenRotateResponse

Methods:

• client.zeroTrust.access.serviceTokens.create({ ...params }) -> ServiceTokenCreateResponse
• client.zeroTrust.access.serviceTokens.update(serviceTokenId, { ...params }) -> ServiceToken
• client.zeroTrust.access.serviceTokens.list({ ...params }) -> ServiceTokensV4PagePaginationArray
• client.zeroTrust.access.serviceTokens.delete(serviceTokenId, { ...params }) -> ServiceToken
• client.zeroTrust.access.serviceTokens.get(serviceTokenId, { ...params }) -> ServiceToken
• client.zeroTrust.access.serviceTokens.refresh(serviceTokenId, { ...params }) -> ServiceToken
• client.zeroTrust.access.serviceTokens.rotate(serviceTokenId, { ...params }) -> ServiceTokenRotateResponse

Bookmarks

Types:

• Bookmark
• BookmarkDeleteResponse

Methods:

• client.zeroTrust.access.bookmarks.create(bookmarkId, { ...params }) -> Bookmark
• client.zeroTrust.access.bookmarks.update(bookmarkId, { ...params }) -> Bookmark
• client.zeroTrust.access.bookmarks.list({ ...params }) -> BookmarksSinglePage
• client.zeroTrust.access.bookmarks.delete(bookmarkId, { ...params }) -> BookmarkDeleteResponse
• client.zeroTrust.access.bookmarks.get(bookmarkId, { ...params }) -> Bookmark

Keys

Types:

• KeyUpdateResponse
• KeyGetResponse
• KeyRotateResponse

Methods:

• client.zeroTrust.access.keys.update({ ...params }) -> KeyUpdateResponse
• client.zeroTrust.access.keys.get({ ...params }) -> KeyGetResponse
• client.zeroTrust.access.keys.rotate({ ...params }) -> KeyRotateResponse

Logs

AccessRequests

Types:

• AccessRequestListResponse

Methods:

• client.zeroTrust.access.logs.accessRequests.list({ ...params }) -> AccessRequestListResponse

SCIM

Types:

• AccessRequest

Updates

Types:

• UpdateListResponse

Methods:

• client.zeroTrust.access.logs.scim.updates.list({ ...params }) -> UpdateListResponsesV4PagePaginationArray

Users

Types:

• AccessUser
• UserCreateResponse
• UserUpdateResponse
• UserListResponse
• UserDeleteResponse
• UserGetResponse

Methods:

• client.zeroTrust.access.users.create({ ...params }) -> UserCreateResponse
• client.zeroTrust.access.users.update(userId, { ...params }) -> UserUpdateResponse
• client.zeroTrust.access.users.list({ ...params }) -> UserListResponsesV4PagePaginationArray
• client.zeroTrust.access.users.delete(userId, { ...params }) -> UserDeleteResponse | null
• client.zeroTrust.access.users.get(userId, { ...params }) -> UserGetResponse

ActiveSessions

Types:

• ActiveSessionListResponse
• ActiveSessionGetResponse

Methods:

• client.zeroTrust.access.users.activeSessions.list(userId, { ...params }) -> ActiveSessionListResponsesSinglePage
• client.zeroTrust.access.users.activeSessions.get(userId, nonce, { ...params }) -> ActiveSessionGetResponse

LastSeenIdentity

Types:

• Identity

Methods:

• client.zeroTrust.access.users.lastSeenIdentity.get(userId, { ...params }) -> Identity

FailedLogins

Types:

• FailedLoginListResponse

Methods:

• client.zeroTrust.access.users.failedLogins.list(userId, { ...params }) -> FailedLoginListResponsesSinglePage

CustomPages

Types:

• CustomPage
• CustomPageWithoutHTML
• CustomPageDeleteResponse

Methods:

• client.zeroTrust.access.customPages.create({ ...params }) -> CustomPageWithoutHTML
• client.zeroTrust.access.customPages.update(customPageId, { ...params }) -> CustomPageWithoutHTML
• client.zeroTrust.access.customPages.list({ ...params }) -> CustomPageWithoutHTMLsV4PagePaginationArray
• client.zeroTrust.access.customPages.delete(customPageId, { ...params }) -> CustomPageDeleteResponse
• client.zeroTrust.access.customPages.get(customPageId, { ...params }) -> CustomPage

Tags

Types:

• Tag
• TagDeleteResponse

Methods:

• client.zeroTrust.access.tags.create({ ...params }) -> Tag
• client.zeroTrust.access.tags.update(tagName, { ...params }) -> Tag
• client.zeroTrust.access.tags.list({ ...params }) -> TagsV4PagePaginationArray
• client.zeroTrust.access.tags.delete(tagName, { ...params }) -> TagDeleteResponse
• client.zeroTrust.access.tags.get(tagName, { ...params }) -> Tag

Policies

Types:

• ApprovalGroup
• Policy
• PolicyCreateResponse
• PolicyUpdateResponse
• PolicyListResponse
• PolicyDeleteResponse
• PolicyGetResponse

Methods:

• client.zeroTrust.access.policies.create({ ...params }) -> PolicyCreateResponse
• client.zeroTrust.access.policies.update(policyId, { ...params }) -> PolicyUpdateResponse
• client.zeroTrust.access.policies.list({ ...params }) -> PolicyListResponsesV4PagePaginationArray
• client.zeroTrust.access.policies.delete(policyId, { ...params }) -> PolicyDeleteResponse
• client.zeroTrust.access.policies.get(policyId, { ...params }) -> PolicyGetResponse

DEX

Types:

• DigitalExperienceMonitor
• NetworkPath
• NetworkPathResponse
• Percentiles

WARPChangeEvents

Types:

• WARPChangeEventGetResponse

Methods:

• client.zeroTrust.dex.warpChangeEvents.get({ ...params }) -> WARPChangeEventGetResponse

Commands

Types:

• CommandCreateResponse
• CommandListResponse

Methods:

• client.zeroTrust.dex.commands.create({ ...params }) -> CommandCreateResponse
• client.zeroTrust.dex.commands.list({ ...params }) -> CommandListResponsesV4PagePagination

Devices

Types:

• DeviceListResponse

Methods:

• client.zeroTrust.dex.commands.devices.list({ ...params }) -> DeviceListResponsesV4PagePagination

Downloads

Methods:

• client.zeroTrust.dex.commands.downloads.get(commandId, filename, { ...params }) -> Response

Quota

Types:

• QuotaGetResponse

Methods:

• client.zeroTrust.dex.commands.quota.get({ ...params }) -> QuotaGetResponse

Colos

Types:

• ColoListResponse

Methods:

• client.zeroTrust.dex.colos.list({ ...params }) -> ColoListResponsesSinglePage

FleetStatus

Types:

• LiveStat
• FleetStatusLiveResponse
• FleetStatusOverTimeResponse

Methods:

• client.zeroTrust.dex.fleetStatus.live({ ...params }) -> FleetStatusLiveResponse
• client.zeroTrust.dex.fleetStatus.overTime({ ...params }) -> FleetStatusOverTimeResponse

Devices

Types:

• DeviceListResponse

Methods:

• client.zeroTrust.dex.fleetStatus.devices.list({ ...params }) -> DeviceListResponsesV4PagePaginationArray

HTTPTests

Types:

• HTTPDetails

Methods:

• client.zeroTrust.dex.httpTests.get(testId, { ...params }) -> HTTPDetails

Percentiles

Types:

• HTTPDetailsPercentiles
• TestStatOverTime

Methods:

• client.zeroTrust.dex.httpTests.percentiles.get(testId, { ...params }) -> HTTPDetailsPercentiles

Tests

Types:

• AggregateTimePeriod
• Tests

Methods:

• client.zeroTrust.dex.tests.list({ ...params }) -> TestsV4PagePagination

UniqueDevices

Types:

• UniqueDevices

Methods:

• client.zeroTrust.dex.tests.uniqueDevices.list({ ...params }) -> UniqueDevices

TracerouteTestResults

NetworkPath

Types:

• NetworkPathGetResponse

Methods:

• client.zeroTrust.dex.tracerouteTestResults.networkPath.get(testResultId, { ...params }) -> NetworkPathGetResponse

TracerouteTests

Types:

• Traceroute
• TracerouteTestPercentilesResponse

Methods:

• client.zeroTrust.dex.tracerouteTests.get(testId, { ...params }) -> Traceroute
• client.zeroTrust.dex.tracerouteTests.networkPath(testId, { ...params }) -> NetworkPathResponse
• client.zeroTrust.dex.tracerouteTests.percentiles(testId, { ...params }) -> TracerouteTestPercentilesResponse

Rules

Types:

• RuleCreateResponse
• RuleUpdateResponse
• RuleListResponse
• RuleDeleteResponse
• RuleGetResponse

Methods:

• client.zeroTrust.dex.rules.create({ ...params }) -> RuleCreateResponse
• client.zeroTrust.dex.rules.update(ruleId, { ...params }) -> RuleUpdateResponse
• client.zeroTrust.dex.rules.list({ ...params }) -> RuleListResponsesV4PagePagination
• client.zeroTrust.dex.rules.delete(ruleId, { ...params }) -> RuleDeleteResponse | null
• client.zeroTrust.dex.rules.get(ruleId, { ...params }) -> RuleGetResponse

Devices

ISPs

Types:

• ISPs

Methods:

• client.zeroTrust.dex.devices.isps.list(deviceId, { ...params }) -> ISPsV4PagePagination

Tunnels

Types:

• Connection
• TunnelListResponse

Methods:

• client.zeroTrust.tunnels.list({ ...params }) -> TunnelListResponsesV4PagePaginationArray

Cloudflared

Methods:

• client.zeroTrust.tunnels.cloudflared.create({ ...params }) -> CloudflareTunnel
• client.zeroTrust.tunnels.cloudflared.list({ ...params }) -> CloudflareTunnelsV4PagePaginationArray
• client.zeroTrust.tunnels.cloudflared.delete(tunnelId, { ...params }) -> CloudflareTunnel
• client.zeroTrust.tunnels.cloudflared.edit(tunnelId, { ...params }) -> CloudflareTunnel
• client.zeroTrust.tunnels.cloudflared.get(tunnelId, { ...params }) -> CloudflareTunnel

Configurations

Types:

• ConfigurationUpdateResponse
• ConfigurationGetResponse

Methods:

• client.zeroTrust.tunnels.cloudflared.configurations.update(tunnelId, { ...params }) -> ConfigurationUpdateResponse
• client.zeroTrust.tunnels.cloudflared.configurations.get(tunnelId, { ...params }) -> ConfigurationGetResponse

Connections

Types:

• Client
• ConnectionDeleteResponse

Methods:

• client.zeroTrust.tunnels.cloudflared.connections.delete(tunnelId, { ...params }) -> ConnectionDeleteResponse | null
• client.zeroTrust.tunnels.cloudflared.connections.get(tunnelId, { ...params }) -> ClientsSinglePage

Token

Types:

• TokenGetResponse

Methods:

• client.zeroTrust.tunnels.cloudflared.token.get(tunnelId, { ...params }) -> TokenGetResponse

Connectors

Methods:

• client.zeroTrust.tunnels.cloudflared.connectors.get(tunnelId, connectorId, { ...params }) -> Client

Management

Types:

• ManagementCreateResponse

Methods:

• client.zeroTrust.tunnels.cloudflared.management.create(tunnelId, { ...params }) -> ManagementCreateResponse

WARPConnector

Types:

• WARPConnectorCreateResponse
• WARPConnectorListResponse
• WARPConnectorDeleteResponse
• WARPConnectorEditResponse
• WARPConnectorGetResponse

Methods:

• client.zeroTrust.tunnels.warpConnector.create({ ...params }) -> WARPConnectorCreateResponse
• client.zeroTrust.tunnels.warpConnector.list({ ...params }) -> WARPConnectorListResponsesV4PagePaginationArray
• client.zeroTrust.tunnels.warpConnector.delete(tunnelId, { ...params }) -> WARPConnectorDeleteResponse
• client.zeroTrust.tunnels.warpConnector.edit(tunnelId, { ...params }) -> WARPConnectorEditResponse
• client.zeroTrust.tunnels.warpConnector.get(tunnelId, { ...params }) -> WARPConnectorGetResponse

Token

Types:

• TokenGetResponse

Methods:

• client.zeroTrust.tunnels.warpConnector.token.get(tunnelId, { ...params }) -> TokenGetResponse

Connections

Types:

• ConnectionGetResponse

Methods:

• client.zeroTrust.tunnels.warpConnector.connections.get(tunnelId, { ...params }) -> ConnectionGetResponsesSinglePage

Connectors

Types:

• ConnectorGetResponse

Methods:

• client.zeroTrust.tunnels.warpConnector.connectors.get(tunnelId, connectorId, { ...params }) -> ConnectorGetResponse

Failover

Types:

• FailoverUpdateResponse

Methods:

• client.zeroTrust.tunnels.warpConnector.failover.update(tunnelId, { ...params }) -> FailoverUpdateResponse | null

Configurations

Types:

• ConfigurationUpdateResponse
• ConfigurationGetResponse

Methods:

• client.zeroTrust.tunnels.warpConnector.configurations.update(tunnelId, { ...params }) -> ConfigurationUpdateResponse
• client.zeroTrust.tunnels.warpConnector.configurations.get(tunnelId, { ...params }) -> ConfigurationGetResponse

ConnectivitySettings

Types:

• ConnectivitySettingEditResponse
• ConnectivitySettingGetResponse

Methods:

• client.zeroTrust.connectivitySettings.edit({ ...params }) -> ConnectivitySettingEditResponse
• client.zeroTrust.connectivitySettings.get({ ...params }) -> ConnectivitySettingGetResponse

DLP

CustomPromptTopics

Types:

• CustomPromptTopic
• CustomPromptTopicDeleteResponse

Methods:

• client.zeroTrust.dlp.customPromptTopics.create({ ...params }) -> CustomPromptTopic
• client.zeroTrust.dlp.customPromptTopics.update(entryId, { ...params }) -> CustomPromptTopic
• client.zeroTrust.dlp.customPromptTopics.list({ ...params }) -> CustomPromptTopicsSinglePage
• client.zeroTrust.dlp.customPromptTopics.delete(entryId, { ...params }) -> CustomPromptTopicDeleteResponse | null
• client.zeroTrust.dlp.customPromptTopics.get(entryId, { ...params }) -> CustomPromptTopic

Datasets

Types:

• Dataset
• DatasetArray
• DatasetCreation

Methods:

• client.zeroTrust.dlp.datasets.create({ ...params }) -> DatasetCreation
• client.zeroTrust.dlp.datasets.update(datasetId, { ...params }) -> Dataset
• client.zeroTrust.dlp.datasets.list({ ...params }) -> DatasetsSinglePage
• client.zeroTrust.dlp.datasets.delete(datasetId, { ...params }) -> void
• client.zeroTrust.dlp.datasets.get(datasetId, { ...params }) -> Dataset

Upload

Types:

• NewVersion

Methods:

• client.zeroTrust.dlp.datasets.upload.create(datasetId, { ...params }) -> NewVersion
• client.zeroTrust.dlp.datasets.upload.edit(datasetId, version, dataset, { ...params }) -> Dataset

Versions

Types:

• VersionCreateResponse

Methods:

• client.zeroTrust.dlp.datasets.versions.create(datasetId, version, [ ...body ]) -> VersionCreateResponsesSinglePage

Entries

Types:

• EntryCreateResponse

Methods:

• client.zeroTrust.dlp.datasets.versions.entries.create(datasetId, version, entryId, datasetVersionEntry, { ...params }) -> EntryCreateResponse

Patterns

Types:

• PatternValidateResponse

Methods:

• client.zeroTrust.dlp.patterns.validate({ ...params }) -> PatternValidateResponse

PayloadLogs

Types:

• PayloadLogUpdateResponse
• PayloadLogGetResponse

Methods:

• client.zeroTrust.dlp.payloadLogs.update({ ...params }) -> PayloadLogUpdateResponse
• client.zeroTrust.dlp.payloadLogs.get({ ...params }) -> PayloadLogGetResponse

Settings

Types:

• DLPSettings

Methods:

• client.zeroTrust.dlp.settings.update({ ...params }) -> DLPSettings
• client.zeroTrust.dlp.settings.delete({ ...params }) -> DLPSettings
• client.zeroTrust.dlp.settings.edit({ ...params }) -> DLPSettings
• client.zeroTrust.dlp.settings.get({ ...params }) -> DLPSettings

Email

AccountMapping

Types:

• AccountMappingCreateResponse
• AccountMappingGetResponse

Methods:

• client.zeroTrust.dlp.email.accountMapping.create({ ...params }) -> AccountMappingCreateResponse
• client.zeroTrust.dlp.email.accountMapping.get({ ...params }) -> AccountMappingGetResponse

Rules

Types:

• RuleCreateResponse
• RuleUpdateResponse
• RuleListResponse
• RuleDeleteResponse
• RuleBulkEditResponse
• RuleGetResponse

Methods:

• client.zeroTrust.dlp.email.rules.create({ ...params }) -> RuleCreateResponse
• client.zeroTrust.dlp.email.rules.update(ruleId, { ...params }) -> RuleUpdateResponse
• client.zeroTrust.dlp.email.rules.list({ ...params }) -> RuleListResponsesSinglePage
• client.zeroTrust.dlp.email.rules.delete(ruleId, { ...params }) -> RuleDeleteResponse
• client.zeroTrust.dlp.email.rules.bulkEdit({ ...params }) -> RuleBulkEditResponse
• client.zeroTrust.dlp.email.rules.get(ruleId, { ...params }) -> RuleGetResponse

Profiles

Types:

• ContextAwareness
• Profile
• SkipConfiguration

Methods:

• client.zeroTrust.dlp.profiles.list({ ...params }) -> ProfilesSinglePage
• client.zeroTrust.dlp.profiles.get(profileId, { ...params }) -> Profile

Custom

Types:

• CustomProfile
• Pattern
• CustomDeleteResponse

Methods:

• client.zeroTrust.dlp.profiles.custom.create({ ...params }) -> Profile
• client.zeroTrust.dlp.profiles.custom.update(profileId, { ...params }) -> Profile
• client.zeroTrust.dlp.profiles.custom.delete(profileId, { ...params }) -> CustomDeleteResponse | null
• client.zeroTrust.dlp.profiles.custom.get(profileId, { ...params }) -> Profile

Predefined

Types:

• PredefinedProfile
• PredefinedDeleteResponse

Methods:

• client.zeroTrust.dlp.profiles.predefined.update(profileId, { ...params }) -> PredefinedProfile
• client.zeroTrust.dlp.profiles.predefined.delete(profileId, { ...params }) -> PredefinedDeleteResponse | null
• client.zeroTrust.dlp.profiles.predefined.get(profileId, { ...params }) -> PredefinedProfile

Limits

Types:

• LimitListResponse

Methods:

• client.zeroTrust.dlp.limits.list({ ...params }) -> LimitListResponse

Entries

Types:

• EntryCreateResponse
• EntryUpdateResponse
• EntryListResponse
• EntryDeleteResponse
• EntryGetResponse

Methods:

• client.zeroTrust.dlp.entries.create({ ...params }) -> EntryCreateResponse
• client.zeroTrust.dlp.entries.update(entryId, { ...params }) -> EntryUpdateResponse
• client.zeroTrust.dlp.entries.list({ ...params }) -> EntryListResponsesSinglePage
• client.zeroTrust.dlp.entries.delete(entryId, { ...params }) -> EntryDeleteResponse | null
• client.zeroTrust.dlp.entries.get(entryId, { ...params }) -> EntryGetResponse

Custom

Types:

• CustomCreateResponse
• CustomUpdateResponse
• CustomListResponse
• CustomDeleteResponse
• CustomGetResponse

Methods:

• client.zeroTrust.dlp.entries.custom.create({ ...params }) -> CustomCreateResponse
• client.zeroTrust.dlp.entries.custom.update(entryId, { ...params }) -> CustomUpdateResponse
• client.zeroTrust.dlp.entries.custom.list({ ...params }) -> CustomListResponsesSinglePage
• client.zeroTrust.dlp.entries.custom.delete(entryId, { ...params }) -> CustomDeleteResponse | null
• client.zeroTrust.dlp.entries.custom.get(entryId, { ...params }) -> CustomGetResponse

Predefined

Types:

• PredefinedCreateResponse
• PredefinedUpdateResponse
• PredefinedListResponse
• PredefinedDeleteResponse
• PredefinedGetResponse

Methods:

• client.zeroTrust.dlp.entries.predefined.create({ ...params }) -> PredefinedCreateResponse
• client.zeroTrust.dlp.entries.predefined.update(entryId, { ...params }) -> PredefinedUpdateResponse
• client.zeroTrust.dlp.entries.predefined.list({ ...params }) -> PredefinedListResponsesSinglePage
• client.zeroTrust.dlp.entries.predefined.delete(entryId, { ...params }) -> PredefinedDeleteResponse | null
• client.zeroTrust.dlp.entries.predefined.get(entryId, { ...params }) -> PredefinedGetResponse

Integration

Types:

• IntegrationCreateResponse
• IntegrationUpdateResponse
• IntegrationListResponse
• IntegrationDeleteResponse
• IntegrationGetResponse

Methods:

• client.zeroTrust.dlp.entries.integration.create({ ...params }) -> IntegrationCreateResponse
• client.zeroTrust.dlp.entries.integration.update(entryId, { ...params }) -> IntegrationUpdateResponse
• client.zeroTrust.dlp.entries.integration.list({ ...params }) -> IntegrationListResponsesSinglePage
• client.zeroTrust.dlp.entries.integration.delete(entryId, { ...params }) -> IntegrationDeleteResponse | null
• client.zeroTrust.dlp.entries.integration.get(entryId, { ...params }) -> IntegrationGetResponse

SensitivityGroups

Types:

• SensitivityGroupCreateResponse
• SensitivityGroupUpdateResponse
• SensitivityGroupListResponse
• SensitivityGroupDeleteResponse
• SensitivityGroupGetResponse

Methods:

• client.zeroTrust.dlp.sensitivityGroups.create({ ...params }) -> SensitivityGroupCreateResponse
• client.zeroTrust.dlp.sensitivityGroups.update(sensitivityGroupId, { ...params }) -> SensitivityGroupUpdateResponse
• client.zeroTrust.dlp.sensitivityGroups.list({ ...params }) -> SensitivityGroupListResponsesSinglePage
• client.zeroTrust.dlp.sensitivityGroups.delete(sensitivityGroupId, { ...params }) -> SensitivityGroupDeleteResponse | null
• client.zeroTrust.dlp.sensitivityGroups.get(sensitivityGroupId, { ...params }) -> SensitivityGroupGetResponse

Levels

Types:

• LevelCreateResponse
• LevelUpdateResponse
• LevelListResponse
• LevelDeleteResponse
• LevelGetResponse

Methods:

• client.zeroTrust.dlp.sensitivityGroups.levels.create(sensitivityGroupId, { ...params }) -> LevelCreateResponse
• client.zeroTrust.dlp.sensitivityGroups.levels.update(sensitivityGroupId, sensitivityLevelId, { ...params }) -> LevelUpdateResponse
• client.zeroTrust.dlp.sensitivityGroups.levels.list(sensitivityGroupId, { ...params }) -> LevelListResponsesSinglePage
• client.zeroTrust.dlp.sensitivityGroups.levels.delete(sensitivityGroupId, sensitivityLevelId, { ...params }) -> LevelDeleteResponse | null
• client.zeroTrust.dlp.sensitivityGroups.levels.get(sensitivityGroupId, sensitivityLevelId, { ...params }) -> LevelGetResponse

Order

Types:

• OrderUpdateResponse
• OrderGetResponse

Methods:

• client.zeroTrust.dlp.sensitivityGroups.levels.order.update(sensitivityGroupId, { ...params }) -> OrderUpdateResponse
• client.zeroTrust.dlp.sensitivityGroups.levels.order.get(sensitivityGroupId, { ...params }) -> OrderGetResponse

DataTagCategories

Types:

• DataTagCategoryCreateResponse
• DataTagCategoryUpdateResponse
• DataTagCategoryListResponse
• DataTagCategoryDeleteResponse
• DataTagCategoryGetResponse

Methods:

• client.zeroTrust.dlp.dataTagCategories.create({ ...params }) -> DataTagCategoryCreateResponse
• client.zeroTrust.dlp.dataTagCategories.update(categoryId, { ...params }) -> DataTagCategoryUpdateResponse
• client.zeroTrust.dlp.dataTagCategories.list({ ...params }) -> DataTagCategoryListResponsesSinglePage
• client.zeroTrust.dlp.dataTagCategories.delete(categoryId, { ...params }) -> DataTagCategoryDeleteResponse | null
• client.zeroTrust.dlp.dataTagCategories.get(categoryId, { ...params }) -> DataTagCategoryGetResponse

DataTags

Types:

• DataTagCreateResponse
• DataTagUpdateResponse
• DataTagListResponse
• DataTagDeleteResponse
• DataTagGetResponse

Methods:

• client.zeroTrust.dlp.dataTagCategories.dataTags.create(categoryId, { ...params }) -> DataTagCreateResponse
• client.zeroTrust.dlp.dataTagCategories.dataTags.update(categoryId, tagId, { ...params }) -> DataTagUpdateResponse
• client.zeroTrust.dlp.dataTagCategories.dataTags.list(categoryId, { ...params }) -> DataTagListResponsesSinglePage
• client.zeroTrust.dlp.dataTagCategories.dataTags.delete(categoryId, tagId, { ...params }) -> DataTagDeleteResponse | null
• client.zeroTrust.dlp.dataTagCategories.dataTags.get(categoryId, tagId, { ...params }) -> DataTagGetResponse

DataClasses

Types:

• DataClassCreateResponse
• DataClassUpdateResponse
• DataClassListResponse
• DataClassDeleteResponse
• DataClassGetResponse

Methods:

• client.zeroTrust.dlp.dataClasses.create({ ...params }) -> DataClassCreateResponse
• client.zeroTrust.dlp.dataClasses.update(dataClassId, { ...params }) -> DataClassUpdateResponse
• client.zeroTrust.dlp.dataClasses.list({ ...params }) -> DataClassListResponsesSinglePage
• client.zeroTrust.dlp.dataClasses.delete(dataClassId, { ...params }) -> DataClassDeleteResponse | null
• client.zeroTrust.dlp.dataClasses.get(dataClassId, { ...params }) -> DataClassGetResponse

Gateway

Types:

• GatewayCreateResponse
• GatewayListResponse

Methods:

• client.zeroTrust.gateway.create({ ...params }) -> GatewayCreateResponse
• client.zeroTrust.gateway.list({ ...params }) -> GatewayListResponse

AuditSSHSettings

Types:

• GatewaySettings

Methods:

• client.zeroTrust.gateway.auditSSHSettings.update({ ...params }) -> GatewaySettings
• client.zeroTrust.gateway.auditSSHSettings.get({ ...params }) -> GatewaySettings
• client.zeroTrust.gateway.auditSSHSettings.rotateSeed({ ...params }) -> GatewaySettings

Categories

Types:

• Category

Methods:

• client.zeroTrust.gateway.categories.list({ ...params }) -> CategoriesSinglePage

AppTypes

Types:

• AppType

Methods:

• client.zeroTrust.gateway.appTypes.list({ ...params }) -> AppTypesSinglePage

Configurations

Types:

• ActivityLogSettings
• AntiVirusSettings
• BlockPageSettings
• BodyScanningSettings
• BrowserIsolationSettings
• CustomCertificateSettings
• ExtendedEmailMatching
• FipsSettings
• GatewayConfigurationSettings
• NotificationSettings
• ProtocolDetection
• TLSSettings
• ConfigurationUpdateResponse
• ConfigurationEditResponse
• ConfigurationGetResponse

Methods:

• client.zeroTrust.gateway.configurations.update({ ...params }) -> ConfigurationUpdateResponse
• client.zeroTrust.gateway.configurations.edit({ ...params }) -> ConfigurationEditResponse
• client.zeroTrust.gateway.configurations.get({ ...params }) -> ConfigurationGetResponse

CustomCertificate

Methods:

• client.zeroTrust.gateway.configurations.customCertificate.get({ ...params }) -> CustomCertificateSettings | null

Lists

Types:

• GatewayItem
• GatewayList
• ListCreateResponse
• ListDeleteResponse

Methods:

• client.zeroTrust.gateway.lists.create({ ...params }) -> ListCreateResponse
• client.zeroTrust.gateway.lists.update(listId, { ...params }) -> GatewayList
• client.zeroTrust.gateway.lists.list({ ...params }) -> GatewayListsSinglePage
• client.zeroTrust.gateway.lists.delete(listId, { ...params }) -> ListDeleteResponse
• client.zeroTrust.gateway.lists.edit(listId, { ...params }) -> GatewayList
• client.zeroTrust.gateway.lists.get(listId, { ...params }) -> GatewayList

Items

Methods:

• client.zeroTrust.gateway.lists.items.list(listId, { ...params }) -> GatewayItemsSinglePage

Locations

Types:

• DOHEndpoint
• DOTEndpoint
• Endpoint
• IPNetwork
• IPV4Endpoint
• IPV6Endpoint
• IPV6Network
• Location
• LocationDeleteResponse

Methods:

• client.zeroTrust.gateway.locations.create({ ...params }) -> Location
• client.zeroTrust.gateway.locations.update(locationId, { ...params }) -> Location
• client.zeroTrust.gateway.locations.list({ ...params }) -> LocationsSinglePage
• client.zeroTrust.gateway.locations.delete(locationId, { ...params }) -> LocationDeleteResponse
• client.zeroTrust.gateway.locations.get(locationId, { ...params }) -> Location

Logging

Types:

• LoggingSetting

Methods:

• client.zeroTrust.gateway.logging.update({ ...params }) -> LoggingSetting
• client.zeroTrust.gateway.logging.get({ ...params }) -> LoggingSetting

ProxyEndpoints

Types:

• GatewayIPs
• ProxyEndpoint
• ProxyEndpointDeleteResponse

Methods:

• client.zeroTrust.gateway.proxyEndpoints.create({ ...params }) -> ProxyEndpoint
• client.zeroTrust.gateway.proxyEndpoints.list({ ...params }) -> ProxyEndpointsSinglePage
• client.zeroTrust.gateway.proxyEndpoints.delete(proxyEndpointId, { ...params }) -> ProxyEndpointDeleteResponse
• client.zeroTrust.gateway.proxyEndpoints.edit(proxyEndpointId, { ...params }) -> ProxyEndpoint
• client.zeroTrust.gateway.proxyEndpoints.get(proxyEndpointId, { ...params }) -> ProxyEndpoint

Rules

Types:

• DNSResolverSettingsV4
• DNSResolverSettingsV6
• GatewayFilter
• GatewayRule
• RuleSetting
• Schedule
• RuleDeleteResponse

Methods:

• client.zeroTrust.gateway.rules.create({ ...params }) -> GatewayRule
• client.zeroTrust.gateway.rules.update(ruleId, { ...params }) -> GatewayRule
• client.zeroTrust.gateway.rules.list({ ...params }) -> GatewayRulesSinglePage
• client.zeroTrust.gateway.rules.delete(ruleId, { ...params }) -> RuleDeleteResponse
• client.zeroTrust.gateway.rules.get(ruleId, { ...params }) -> GatewayRule
• client.zeroTrust.gateway.rules.listTenant({ ...params }) -> GatewayRulesSinglePage
• client.zeroTrust.gateway.rules.resetExpiration(ruleId, { ...params }) -> GatewayRule

Certificates

Types:

• CertificateCreateResponse
• CertificateListResponse
• CertificateDeleteResponse
• CertificateActivateResponse
• CertificateDeactivateResponse
• CertificateGetResponse

Methods:

• client.zeroTrust.gateway.certificates.create({ ...params }) -> CertificateCreateResponse
• client.zeroTrust.gateway.certificates.list({ ...params }) -> CertificateListResponsesSinglePage
• client.zeroTrust.gateway.certificates.delete(certificateId, { ...params }) -> CertificateDeleteResponse
• client.zeroTrust.gateway.certificates.activate(certificateId, { ...params }) -> CertificateActivateResponse
• client.zeroTrust.gateway.certificates.deactivate(certificateId, { ...params }) -> CertificateDeactivateResponse
• client.zeroTrust.gateway.certificates.get(certificateId, { ...params }) -> CertificateGetResponse

Pacfiles

Types:

• PacfileCreateResponse
• PacfileUpdateResponse
• PacfileListResponse
• PacfileDeleteResponse
• PacfileGetResponse

Methods:

• client.zeroTrust.gateway.pacfiles.create({ ...params }) -> PacfileCreateResponse
• client.zeroTrust.gateway.pacfiles.update(pacfileId, { ...params }) -> PacfileUpdateResponse
• client.zeroTrust.gateway.pacfiles.list({ ...params }) -> PacfileListResponsesSinglePage
• client.zeroTrust.gateway.pacfiles.delete(pacfileId, { ...params }) -> PacfileDeleteResponse
• client.zeroTrust.gateway.pacfiles.get(pacfileId, { ...params }) -> PacfileGetResponse

Networks

Routes

Types:

• NetworkRoute
• Route
• Teamnet

Methods:

• client.zeroTrust.networks.routes.create({ ...params }) -> Route
• client.zeroTrust.networks.routes.list({ ...params }) -> TeamnetsV4PagePaginationArray
• client.zeroTrust.networks.routes.delete(routeId, { ...params }) -> Route
• client.zeroTrust.networks.routes.edit(routeId, { ...params }) -> Route
• client.zeroTrust.networks.routes.get(routeId, { ...params }) -> Route

IPs

Methods:

• client.zeroTrust.networks.routes.ips.get(ip, { ...params }) -> Teamnet

Networks

Methods:

• client.zeroTrust.networks.routes.networks.create(ipNetworkEncoded, { ...params }) -> Route
• client.zeroTrust.networks.routes.networks.delete(ipNetworkEncoded, { ...params }) -> Route
• client.zeroTrust.networks.routes.networks.edit(ipNetworkEncoded, { ...params }) -> Route

VirtualNetworks

Types:

• VirtualNetwork

Methods:

• client.zeroTrust.networks.virtualNetworks.create({ ...params }) -> VirtualNetwork
• client.zeroTrust.networks.virtualNetworks.list({ ...params }) -> VirtualNetworksSinglePage
• client.zeroTrust.networks.virtualNetworks.delete(virtualNetworkId, { ...params }) -> VirtualNetwork
• client.zeroTrust.networks.virtualNetworks.edit(virtualNetworkId, { ...params }) -> VirtualNetwork
• client.zeroTrust.networks.virtualNetworks.get(virtualNetworkId, { ...params }) -> VirtualNetwork

Subnets

Methods:

• client.zeroTrust.networks.subnets.list({ ...params }) -> SubnetsV4PagePaginationArray

WARP

Types:

• Subnet
• WARPDeleteResponse

Methods:

• client.zeroTrust.networks.subnets.warp.create({ ...params }) -> Subnet
• client.zeroTrust.networks.subnets.warp.delete(subnetId, { ...params }) -> WARPDeleteResponse | null
• client.zeroTrust.networks.subnets.warp.edit(subnetId, { ...params }) -> Subnet
• client.zeroTrust.networks.subnets.warp.get(subnetId, { ...params }) -> Subnet

CloudflareSource

Methods:

• client.zeroTrust.networks.subnets.cloudflareSource.update(addressFamily, { ...params }) -> Subnet

HostnameRoutes

Types:

• HostnameRoute

Methods:

• client.zeroTrust.networks.hostnameRoutes.create({ ...params }) -> HostnameRoute
• client.zeroTrust.networks.hostnameRoutes.list({ ...params }) -> HostnameRoutesV4PagePaginationArray
• client.zeroTrust.networks.hostnameRoutes.delete(hostnameRouteId, { ...params }) -> HostnameRoute
• client.zeroTrust.networks.hostnameRoutes.edit(hostnameRouteId, { ...params }) -> HostnameRoute
• client.zeroTrust.networks.hostnameRoutes.get(hostnameRouteId, { ...params }) -> HostnameRoute

RiskScoring

Types:

• RiskScoringGetResponse
• RiskScoringResetResponse

Methods:

• client.zeroTrust.riskScoring.get(userId, { ...params }) -> RiskScoringGetResponse
• client.zeroTrust.riskScoring.reset(userId, { ...params }) -> RiskScoringResetResponse | null

Behaviours

Types:

• BehaviourUpdateResponse
• BehaviourGetResponse

Methods:

• client.zeroTrust.riskScoring.behaviours.update({ ...params }) -> BehaviourUpdateResponse
• client.zeroTrust.riskScoring.behaviours.get({ ...params }) -> BehaviourGetResponse

Summary

Types:

• SummaryGetResponse

Methods:

• client.zeroTrust.riskScoring.summary.get({ ...params }) -> SummaryGetResponse

Integrations

Types:

• IntegrationCreateResponse
• IntegrationUpdateResponse
• IntegrationListResponse
• IntegrationDeleteResponse
• IntegrationGetResponse

Methods:

• client.zeroTrust.riskScoring.integrations.create({ ...params }) -> IntegrationCreateResponse
• client.zeroTrust.riskScoring.integrations.update(integrationId, { ...params }) -> IntegrationUpdateResponse
• client.zeroTrust.riskScoring.integrations.list({ ...params }) -> IntegrationListResponsesSinglePage
• client.zeroTrust.riskScoring.integrations.delete(integrationId, { ...params }) -> IntegrationDeleteResponse | null
• client.zeroTrust.riskScoring.integrations.get(integrationId, { ...params }) -> IntegrationGetResponse

References

Types:

• ReferenceGetResponse

Methods:

• client.zeroTrust.riskScoring.integrations.references.get(referenceId, { ...params }) -> ReferenceGetResponse

ResourceLibrary

Applications

Types:

• ApplicationListResponse
• ApplicationGetResponse

Methods:

• client.zeroTrust.resourceLibrary.applications.list({ ...params }) -> ApplicationListResponsesSinglePage
• client.zeroTrust.resourceLibrary.applications.get(id, { ...params }) -> ApplicationGetResponse

Categories

Types:

• CategoryListResponse
• CategoryGetResponse

Methods:

• client.zeroTrust.resourceLibrary.categories.list({ ...params }) -> CategoryListResponsesSinglePage
• client.zeroTrust.resourceLibrary.categories.get(id, { ...params }) -> CategoryGetResponse