Gravitee · Schema
Gravitee Security Domain
Represents a security domain in the Gravitee Access Management platform that defines authentication and authorization boundaries for applications and users.
API GatewayAPI ManagementAccess ManagementIdentityEvent-DrivenEvent ManagementKafka GatewayKafkaMQTTGraphQLgRPCAI GatewayMCPA2ALLM ProxyMulti-Gateway FederationDeveloper PortalOpen SourceApache 2.0
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier for the security domain. |
| name | string | Name of the security domain. |
| description | string | Description of the security domain. |
| enabled | boolean | Whether the domain is currently active and processing requests. |
| path | string | Context path for the domain used in URL routing. |
| oidc | object | OpenID Connect protocol configuration. |
| scim | object | SCIM protocol configuration for user provisioning. |
| loginSettings | object | Login page customization settings. |
| createdAt | string | Timestamp when the domain was created. |
| updatedAt | string | Timestamp when the domain was last updated. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://gravitee.io/schemas/gravitee/domain.json",
"title": "Gravitee Security Domain",
"description": "Represents a security domain in the Gravitee Access Management platform that defines authentication and authorization boundaries for applications and users.",
"type": "object",
"required": ["name"],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the security domain."
},
"name": {
"type": "string",
"description": "Name of the security domain.",
"minLength": 1
},
"description": {
"type": "string",
"description": "Description of the security domain."
},
"enabled": {
"type": "boolean",
"description": "Whether the domain is currently active and processing requests.",
"default": true
},
"path": {
"type": "string",
"description": "Context path for the domain used in URL routing."
},
"oidc": {
"type": "object",
"description": "OpenID Connect protocol configuration.",
"additionalProperties": true
},
"scim": {
"type": "object",
"description": "SCIM protocol configuration for user provisioning.",
"additionalProperties": true
},
"loginSettings": {
"type": "object",
"description": "Login page customization settings.",
"properties": {
"inherited": {
"type": "boolean",
"description": "Whether settings are inherited from the organization level."
},
"forgotPasswordEnabled": {
"type": "boolean",
"description": "Whether the forgot password feature is enabled."
},
"registerEnabled": {
"type": "boolean",
"description": "Whether self-registration is enabled."
}
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the domain was created."
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the domain was last updated."
}
}
}