Sign in

v1

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-06-26162897.8 KB
Domains

List all domains

Returns all security domains within the specified environment.

get/organizations/{orgId}/environments/{envId}/domains

Path parameters

orgIdstring required

Identifier of the organization that owns the environment.

envIdstring required

Identifier of the environment the domain belongs to.

Response

List of domains

alertEnabledboolean

Whether alerting is enabled for the domain.

createdAtstring date-time

Creation timestamp (ISO-8601 / RFC 3339, UTC). Read-only.

dataPlaneIdstring required

Identifier of the data plane this domain is connected to. Required at creation and immutable afterwards; included in the desired-state document but never re-applied on update.

descriptionstring

Human-readable description of the domain.

enabledboolean

Whether the domain handles incoming authentication and authorization requests.

keystring required

Stable, immutable identifier for the domain within its environment. Lowercase alphanumeric and hyphens, starting and ending with an alphanumeric character. Used to identify the domain on create-or-update.

masterboolean

Whether this is the master domain of its environment. A master domain may perform cross-domain token introspection.

namestring required

Human-readable name of the domain.

pathstring required

Context path the domain is served under, relative to the gateway. Must start with a slash.

tagsstring[]

Sharding tags that control which gateways deploy this domain.

updatedAtstring date-time

Last-update timestamp (ISO-8601 / RFC 3339, UTC). Read-only.

vhostModeboolean

Whether the domain is exposed through its virtual hosts rather than the default context path. When true, vhosts must be supplied.

Example response

[
  {
    "accountSettings": {
      "accountBlockedDuration": 7200,
      "defaultIdentityProviderForRegistration": "users-idp",
      "loginAttemptsResetTime": 600,
      "maxLoginAttempts": 10,
      "mfaChallengeAttemptsResetTime": 600,
      "mfaChallengeMaxAttempts": 3,
      "redirectUriAfterRegistration": "https://app.example.com/welcome",
      "redirectUriAfterResetPassword": "https://app.example.com/signin",
      "rememberMeDuration": 604800,
      "resetPasswordCustomFormFields": [
        {
          "key": "email",
          "label": "Email",
          "type": "email"
        }
      ]
    },
    "certificateSettings": {
      "fallbackCertificate": "default"
    },
    "corsSettings": {
      "allowedHeaders": [
        "Authorization",
        "Content-Type"
      ],
      "allowedMethods": [
        "GET",
        "POST",
        "PUT",
        "DELETE"
      ],
      "allowedOrigins": [
        "https://app.example.com"
      ]
    },
    "dataPlaneId": "default",
    "description": "An example authentication domain",
    "key": "example-domain",
    "name": "Example domain",
    "oidc": {
      "cibaSettings": {
        "authReqExpiry": 600,
        "bindingMessageLength": 256,
        "tokenReqInterval": 5
      }
    },
    "path": "/example-domain",
    "saml": {
      "certificate": "signing-cert",
      "entityId": "https://auth.example.com/saml2/idp/entity"
    },
    "secretExpirationSettings": {
      "expiryTimeSeconds": 7776000
    },
    "tags": [
      "eu",
      "production"
    ],
    "tokenExchangeSettings": {
      "allowedActorTokenTypes": [
        "urn:ietf:params:oauth:token-type:access_token",
        "urn:ietf:params:oauth:token-type:id_token"
      ],
      "allowedRequestedTokenTypes": [
        "urn:ietf:params:oauth:token-type:access_token",
        "urn:ietf:params:oauth:token-type:id_token"
      ],
      "allowedSubjectTokenTypes": [
        "urn:ietf:params:oauth:token-type:access_token",
        "urn:ietf:params:oauth:token-type:id_token"
      ],
      "trustedIssuers": [
        {
          "issuer": "https://issuer.example.com",
          "jwksUri": "https://issuer.example.com/.well-known/jwks.json",
          "userBindingCriteria": [
            {
              "attribute": "emails.value",
              "expression": "{#token['email']}"
            }
          ]
        }
      ]
    },
    "vhosts": [
      {
        "host": "auth.example.com",
        "path": "/customers"
      }
    ],
    "webAuthnSettings": {
      "origin": "https://auth.example.com",
      "relyingPartyId": "auth.example.com",
      "relyingPartyName": "Example Inc."
    }
  }
]