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

Go to download
{
  "type" : "object",
  "id" : "urn:jsonschema:io:gravitee:am:identityprovider:mongo:MongoIdentityProviderConfiguration",
  "properties" : {
    "uri" : {
      "type" : "string",
      "default": "mongodb://localhost:27017",
      "title": "MongoDB connection URI",
      "description": "Connection URI used to connect to a MongoDB instance."
    },
    "host" : {
      "type" : "string",
      "default": "localhost",
      "title": "MongoDB connection host",
      "description": "Not required if the MongoDB connection URI is set."
    },
    "port" : {
      "type": "number",
      "default": 27017,
      "minimum": 1,
      "title": "MongoDB connection port",
      "description": "Not required if the MongoDB connection URI is set."
    },
    "enableCredentials" : {
      "type" : "boolean",
      "default": false,
      "title": "Secure access to MongoDB",
      "description": "If MongoDB database need an authentication, this flag must be enabled."
    },
    "databaseCredentials" : {
      "type" : "string",
      "title": "Authentication database",
      "description": "Database used for authentication."
    },
    "usernameCredentials" : {
      "type" : "string",
      "title": "Authentication user",
      "description": "User used to authenticate."
    },
    "passwordCredentials" : {
      "type" : "string",
      "title": "Authentication password",
      "description": "Password used to authenticate.",
      "widget": "password"
    },
    "database" : {
      "type" : "string",
      "title": "The database used to run query",
      "description": "The MongoDB database used to run query to search for users."
    },
    "usersCollection" : {
      "type" : "string",
      "default": "users",
      "title": "The collection used to run query",
      "description": "The collection which is containing all the users."
    },
    "findUserByUsernameQuery" : {
      "type" : "string",
      "default": "{username: ?}",
      "title": "Query to find for a user using its identifier (username)",
      "description": "The query which is executed to search for an user using its identifier (username)."
    },
    "findUserByEmailQuery" : {
      "type" : "string",
      "default": "{email: ?}",
      "title": "Query to find for a user using its email",
      "description": "The query which is executed to search for an user using its email."
    },
    "usernameField" : {
      "type" : "string",
      "default": "username",
      "title": "Username field",
      "description": "The user username field (must be in the same collection as the users)."
    },
    "passwordField" : {
      "type" : "string",
      "default": "password",
      "title": "Password field",
      "description": "The user password field (must be in the same collection as the users)."
    },
    "passwordEncoder" : {
      "type": "string",
      "enum": ["BCrypt", "None"],
      "default": "BCrypt",
      "title": "Password encoder",
      "description": "The encoding mechanism to store password value."
    }
  },
  "required": [
    "database",
    "usersCollection",
    "findUserByUsernameQuery",
    "findUserByEmailQuery",
    "usernameField",
    "passwordField",
    "passwordEncoder"
  ]
}