GRgravitee-io
Domains

Get a domain

Changed on

Retrieves a single Automation-managed security domain by its key.

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

Request

  • Base URL
    http://localhost:8093/automation
  • URL
    http://localhost:8093/automation/organizations/{orgId}/environments/{envId}/domains/{domainKey}
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Identifier of the organization that owns the environment.

envIdstring required

Identifier of the environment the resource belongs to.

domainKeystring required

Key of the domain: its stable, immutable Automation identifier within the environment.

Response

The domain

alertEnabledboolean

Whether alerting is enabled for the domain.

createdAtstring date-time

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

dataPlaneIdstring

Identifier of the data plane this domain is connected to. Optional at creation and resolved from the environment's data planes when omitted. Immutable afterwards: an apply that names a different one is rejected.

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",
  "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."
  },
  "webProtectionSettings": {
    "csp": {
      "directives": [
        "default-src 'self'",
        "script-src 'self'",
        "upgrade-insecure-requests"
      ]
    },
    "xframe": {
      "action": "DENY"
    },
    "xss": {
      "action": "1; mode=block"
    }
  }
}

Changes

  • b0b6bdfd65cbRevision changes
    • warning

      added the new DENY enum value to the // response property for the response status

    • warning

      added the new SAMEORIGIN enum value to the // response property for the response status

    • info

      the response's property pattern ^/.* was added for the status

  • 821321fb3bcfRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value false was added for the status

    • info

      the response's property default value 600 was added for the status

    • info

      the response's property default value 256 was added for the status

    • info

      the response's property default value RS256 RS384 RS512 ES256 ES384 ES512 EdDSA was added for the status

    • info

      the response's property default value 5 was added for the status

    • info

      the response's property default value false was removed for the status

    • info

      the response's property default value false was removed for the status

    • info

      the response's property default value 50 was removed for the status

    • info

      the response's property default value 300 was removed for the status

    • info

      the response's property default value 5000 was removed for the status

    • info

      the response's property default value 32 was removed for the status

    • info

      response property oidc/workloadIdentitySettings/allowPrivateIpAddress deprecated

    • info

      response property oidc/workloadIdentitySettings/allowUnsecuredHttpUri deprecated

    • info

      response property oidc/workloadIdentitySettings/cacheMaxEntries deprecated

    • info

      response property oidc/workloadIdentitySettings/cacheTtlSeconds deprecated

    • info

      response property oidc/workloadIdentitySettings/fetchTimeoutMs deprecated

    • info

      response property oidc/workloadIdentitySettings/maxResponseSizeKb deprecated

    • info

      response property tokenExchangeSettings/trustedIssuers deprecated

    • info

      response property tokenExchangeSettings/trustedIssuers/items/ deprecated