POST /accounts/{account_id}/access/organizations

Sets up a Zero Trust organization for your account.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
session_duration String No

The amount of time that tokens issued for applications will be valid. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m, h.

user_seat_expiration_inactive_time String No

The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Minimum value for this setting is 1 month (730h). Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m, h.

name String Yes

The name of your Zero Trust organization.

auth_domain String Yes

The unique subdomain assigned to your Zero Trust organization.

allow_authenticate_via_warp Boolean No

When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value.

is_ui_read_only Boolean No

Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled.

warp_auth_session_duration String No

The amount of time that tokens issued for applications will be valid. Must be in the format 30m or 2h45m. Valid time units are: m, h.

login_design Object No
login_design.header_text String No

The text at the top of your login page.

login_design.background_color String No

The background color on your login page.

login_design.logo_path String No

The URL of the logo on your login page.

login_design.footer_text String No

The text at the bottom of your login page.

login_design.text_color String No

The text color on your login page.

ui_read_only_toggle_reason String No

A description of the reason why the UI read only field is being toggled.

auto_redirect_to_identity Boolean No

When set to true, users skip the identity provider selection step during login.

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.