json.schema.configuration.ldapConfiguration.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/configuration/ldapConfiguration.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "LdapConfiguration",
  "description": "LDAP Configuration",
  "type": "object",
  "javaType": "org.openmetadata.schema.auth.LdapConfiguration",
  "properties": {
    "host": {
      "description": "LDAP server address without scheme(Example :- localhost)",
      "type": "string"
    },
    "port": {
      "description": "Port of the server",
      "type": "integer"
    },
    "maxPoolSize": {
      "description": "No of connection to create the pool with",
      "type": "integer",
      "default": 3
    },
    "isFullDn": {
      "description": "If enable need to give full dn to login",
      "type": "boolean",
      "default": false
    },
    "dnAdminPrincipal": {
      "description": "Distinguished Admin name with search capabilities",
      "type": "string"
    },
    "dnAdminPassword": {
      "description": "Password for LDAP Admin",
      "type": "string"
    },
    "sslEnabled": {
      "description": "LDAPS (secure LDAP) or LDAP",
      "type": "boolean",
      "default": false
    },
    "userBaseDN": {
      "description": "User base distinguished name",
      "type": "string"
    },
    "groupBaseDN": {
      "description": "Group base distinguished name",
      "type": "string"
    },
    "roleAdminName": {
      "description": "Admin role name",
      "type": "string"
    },
    "allAttributeName": {
      "description": "All attribute name",
      "type": "string"
    },
    "mailAttributeName": {
      "description": "Email attribute name",
      "type": "string"
    },
    "usernameAttributeName": {
      "description": "User Name attribute name",
      "type": "string"
    },
    "groupAttributeName": {
      "description": "Group Name attribute name",
      "type": "string"
    },
    "groupAttributeValue": {
      "description": "Group attribute value",
      "type": "string"
    },
    "groupMemberAttributeName": {
      "description": "Group Member Name attribute name",
      "type": "string"
    },
    "authRolesMapping": {
      "description": "Json string of roles mapping between LDAP roles and Ranger roles",
      "type": "string"
    },
    "authReassignRoles": {
      "description": "Roles should be reassign every time user login",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "truststoreFormat": {
      "description": "Truststore format e.g. PKCS12, JKS.",
      "type": "string"
    },
    "truststoreConfigType": {
      "description": "Truststore Type e.g. TrustAll, HostName, JVMDefault, CustomTrustStore.",
      "type": "string",
      "enum": ["TrustAll", "JVMDefault", "HostName", "CustomTrustStore"]
    },
    "trustStoreConfig": {
      "description": "Truststore Configuration",
      "$ref": "ldapTrustStoreConfig/truststoreConfig.json"
    }
  },
  "required": ["host", "port", "dnAdminPrincipal","dnAdminPassword", "userBaseDN", "mailAttributeName"],
  "additionalProperties": false
}