json.schema.configuration.authorizerConfiguration.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
  "$id": "https://open-metadata.org/schema/entity/configuration/authorizerConfiguration.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AuthorizerConfiguration",
  "description": "This schema defines the Authorization Configuration.",
  "type": "object",
  "javaType": "org.openmetadata.schema.api.security.AuthorizerConfiguration",
  "properties": {
    "className": {
      "description": "Class Name for authorizer.",
      "type": "string"
    },
    "containerRequestFilter": {
      "description": "Filter for the request authorization.",
      "type": "string"
    },
    "adminPrincipals": {
      "description": "List of unique admin principals.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "botPrincipals": {
      "description": "**@Deprecated** List of unique bot principals",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "default": null
    },
    "testPrincipals": {
      "description": "List of unique principals used as test users. **NOTE THIS IS ONLY FOR TEST SETUP AND NOT TO BE USED IN PRODUCTION SETUP**",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "allowedEmailRegistrationDomains": {
      "description": "List of unique email domains that are allowed to signup on the platforms",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "principalDomain": {
      "description": "Principal Domain",
      "type": "string"
    },
    "enforcePrincipalDomain": {
      "description": "Enable Enforce Principal Domain",
      "type": "boolean"
    },
    "enableSecureSocketConnection": {
      "description": "Enable Secure Socket Connection.",
      "type": "boolean"
    },
    "useRolesFromProvider": {
      "description": "Use Roles from Provider",
      "type": "boolean",
      "default": false
    }
  },
  "required": ["className", "containerRequestFilter", "adminPrincipals", "principalDomain", "enforcePrincipalDomain", "enableSecureSocketConnection"],
  "additionalProperties": false
}