schemas.schema-form.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-resource-auth-provider-ldap Show documentation
The resource is defined to authenticate a user in LDAP.
The newest version!
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type" : "object",
  "properties" : {
    "contextSourceUrl" : {
      "type" : "string",
      "title": "LDAP URL",
      "description": "The URL of the LDAP server to use. The URL should be in the format ldap://myserver.example.com:389. For SSL access, use the ldaps protocol and the appropriate port, e.g. ldaps://myserver.example.com:636. If fail-over functionality is desired, more than one URL can be specified, separated using comma (,).",
      "default": "ldap://myserver.example.com:389"
    },
    "useStartTLS": {
      "type": "boolean",
      "title": "Use StartTLS ?"
    },
    "contextSourceBase" : {
      "type" : "string",
      "title": "Base DN",
      "description": "The base DN. When this attribute has been configured, all Distinguished Names supplied to and received from LDAP operations will be relative to the specified LDAP path."
    },
    "contextSourceUsername" : {
      "type" : "string",
      "title": "Username",
      "description": "The username (principal) to use when authenticating with the LDAP server. This will usually be the distinguished name of an admin user (e.g.cn=Administrator), but may differ depending on server and authentication method."
    },
    "contextSourcePassword" : {
      "type" : "string",
      "title": "Password",
      "description": "The password (credentials) to use when authenticating with the LDAP server.",
      "widget": "password"
    },
    "userSearchFilter" : {
      "type" : "string",
      "title": "User search filter",
      "default": "uid={0}"
    },
    "userSearchBase" : {
      "type" : "string",
      "default": "ou=users",
      "title": "User search base",
      "description": "If user-search-base isn't supplied, the search will be performed from the root."
    },
    "attributes" : {
      "type" : "array",
      "title": "User LDAP attributes",
      "description": "User LDAP attributes to put in the request context. Attributes can then be read from any other policy supporting EL (gravitee.attribute.user.{attribute})",
      "items" : {
        "type" : "string",
        "title": "Ldap attribute",
        "description": "Name of the LDAP attribute"
      }
    },
    "cacheMaxElements" : {
      "type" : "integer",
      "default": 100,
      "minimum": 0,
      "title": "Cache - Maximum number of elements",
      "description": "Maximum number of elements within the cache used to store successful authentications."
    },
    "cacheTimeToLive" : {
      "type" : "integer",
      "default": 60000,
      "minimum": 1000,
      "title": "Cache - Time To Live",
      "description": "Maximum time to live of the elements from the cache used to store successful authentications."
    },
    "connectTimeout" : {
      "type" : "integer",
      "default": 5000,
      "minimum": 0,
      "title": "Connect timeout",
      "description": "Duration of time in milliseconds that connects will block. (default 5000 ms)"
    },
    "responseTimeout" : {
      "type" : "integer",
      "default": 5000,
      "minimum": 0,
      "title": "Response timeout",
      "description": "Duration of time in milliseconds to wait for responses. (default 5000 ms)"
    },
    "minPoolSize" : {
      "type" : "integer",
      "default": 5,
      "minimum": 0,
      "title": "Min pool size",
      "description": "Minimum pool of connections to be initialized"
    },
    "maxPoolSize" : {
      "type" : "integer",
      "default": 15,
      "minimum": 0,
      "title": "Max pool size",
      "description": "Maximum pool of connections can grow to"
    }
  },
  "required": [
    "contextSourceUrl",
    "contextSourceBase",
    "contextSourceUsername",
    "contextSourcePassword",
    "userSearchFilter",
    "cacheMaxElements",
    "cacheTimeToLive"
  ]
}