• Home
• org.open-metadata
• openmetadata-spec
• 1.5.5
• source code
• authenticationConfiguration.json

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

{
  "$id": "https://open-metadata.org/schema/entity/configuration/authenticationConfiguration.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AuthenticationConfiguration",
  "description": "This schema defines the Authentication Configuration.",
  "type": "object",
  "javaType": "org.openmetadata.schema.api.security.AuthenticationConfiguration",
  "definitions": {
    "responseType": {
      "javaType": "org.openmetadata.schema.api.security.ResponseType",
      "description": "Response Type",
      "type": "string",
      "enum": [
        "id_token",
        "code"
      ],
      "default": "id_token"
    }
  },
  "properties": {
    "clientType": {
      "javaType": "org.openmetadata.schema.api.security.ClientType",
      "description": "Client Type",
      "type": "string",
      "enum": [
        "public",
        "confidential"
      ],
      "default": "public"
    },
    "provider": {
      "$ref": "../entity/services/connections/metadata/openMetadataConnection.json#/definitions/authProvider"
    },
    "responseType": {
      "description": "This is used by auth provider provide response as either id_token or code.",
      "$ref": "#/definitions/responseType"
    },
    "providerName": {
      "description": "Custom OIDC Authentication Provider Name",
      "type": "string"
    },
    "publicKeyUrls": {
      "description": "List of Public Key URLs",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "authority": {
      "description": "Authentication Authority",
      "type": "string"
    },
    "clientId": {
      "description": "Client ID",
      "type": "string"
    },
    "callbackUrl": {
      "description": "Callback URL",
      "type": "string"
    },
    "jwtPrincipalClaims": {
      "description": "Jwt Principal Claim",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "jwtPrincipalClaimsMapping": {
      "description": "Jwt Principal Claim Mapping",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "enableSelfSignup": {
      "description": "Enable Self Sign Up",
      "type": "boolean",
      "default": false
    },
    "ldapConfiguration": {
      "description": "LDAP Configuration in case the Provider is LDAP",
      "$ref": "./ldapConfiguration.json"
    },
    "samlConfiguration": {
      "description": "Saml Configuration that is applicable only when the provider is Saml",
      "$ref": "../security/client/samlSSOClientConfig.json"
    },
    "oidcConfiguration": {
      "description": "Oidc Configuration for Confidential Client Type",
      "$ref": "../security/client/oidcClientConfig.json"
    }
  },
  "required": ["provider", "providerName", "publicKeyUrls", "authority", "callbackUrl", "clientId", "jwtPrincipalClaims"],
  "additionalProperties": false
}