Skip to content
Start here

Custom Pages

List custom pages
client.zeroTrust.access.customPages.list(CustomPageListParams { account_id, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<CustomPageWithoutHTML { name, type, contract_version, 2 more } >
GET/accounts/{account_id}/access/custom_pages
Get a custom page
client.zeroTrust.access.customPages.get(stringcustomPageID, CustomPageGetParams { account_id } params, RequestOptionsoptions?): CustomPage { custom_html, name, type, 2 more }
GET/accounts/{account_id}/access/custom_pages/{custom_page_id}
Validate a custom page template
client.zeroTrust.access.customPages.validate(CustomPageValidateParams { account_id, template, type, version } params, RequestOptionsoptions?): CustomPageValidateResponse { errors, page_type, version, warnings }
POST/accounts/{account_id}/access/custom_pages/validate
Create a custom page
client.zeroTrust.access.customPages.create(CustomPageCreateParams { account_id, custom_html, name, 2 more } params, RequestOptionsoptions?): CustomPageWithoutHTML { name, type, contract_version, 2 more }
POST/accounts/{account_id}/access/custom_pages
Update a custom page
client.zeroTrust.access.customPages.update(stringcustomPageID, CustomPageUpdateParams { account_id, custom_html, name, 2 more } params, RequestOptionsoptions?): CustomPageWithoutHTML { name, type, contract_version, 2 more }
PUT/accounts/{account_id}/access/custom_pages/{custom_page_id}
Delete a custom page
client.zeroTrust.access.customPages.delete(stringcustomPageID, CustomPageDeleteParams { account_id } params, RequestOptionsoptions?): CustomPageDeleteResponse { id }
DELETE/accounts/{account_id}/access/custom_pages/{custom_page_id}
ModelsExpand Collapse
CustomPage { custom_html, name, type, 2 more }
custom_html: string

Custom page HTML.

name: string

Custom page name.

type: "identity_denied" | "forbidden" | "login" | "interstitial"

Custom page type.

One of the following:
"identity_denied"
"forbidden"
"login"
"interstitial"
contract_version?: number

Contract version of the page’s Liquid template. Present (>= 1) marks a sanitized template; absent or 0 marks a legacy page served verbatim.

uid?: string

UUID.

maxLength36
CustomPageWithoutHTML { name, type, contract_version, 2 more }
name: string

Custom page name.

type: "identity_denied" | "forbidden" | "login" | "interstitial"

Custom page type.

One of the following:
"identity_denied"
"forbidden"
"login"
"interstitial"
contract_version?: number

Contract version of the page’s Liquid template. Present (>= 1) marks a sanitized template; absent or 0 marks a legacy page served verbatim.

uid?: string

UUID.

maxLength36
warnings?: Array<Warning>

Advisory validation findings returned when creating or updating a template. Omitted when empty.

message: string

Human-readable description of the finding.

tier: string

The validation tier that produced the finding (e.g. html, liquid).

ref?: string

Optional pointer to the part of the template the finding refers to.

CustomPageValidateResponse { errors, page_type, version, warnings }

The result of validating a template’s content.

errors: Array<Error>

Blocking findings; a non-empty list means the template cannot be published.

message: string

Human-readable description of the finding.

tier: string

The validation tier that produced the finding (e.g. html, liquid).

ref?: string

Optional pointer to the part of the template the finding refers to.

page_type: "identity_denied" | "forbidden" | "login" | "interstitial"

Custom page type.

One of the following:
"identity_denied"
"forbidden"
"login"
"interstitial"
version: number

The contract version the template was validated against.

warnings: Array<Warning>

Advisory findings that do not block publishing.

message: string

Human-readable description of the finding.

tier: string

The validation tier that produced the finding (e.g. html, liquid).

ref?: string

Optional pointer to the part of the template the finding refers to.

CustomPageDeleteResponse { id }
id?: string

UUID.

maxLength36