json.schema.auth.ssoAuth.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/api/auth/ssoAuth.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SSOAuthMechanism",
  "description": "User/Bot SSOAuthN.",
  "type": "object",
  "javaType": "org.openmetadata.schema.auth.SSOAuthMechanism",
  "properties": {
    "ssoServiceType": {
      "description": "Type of database service such as Amundsen, Atlas...",
      "type": "string",
      "enum": ["google", "okta", "auth0", "custom-oidc", "azure"]
    },
    "authConfig": {
      "description": "The authentication configuration used by the SSO",
      "oneOf": [
        {
          "description": "Google SSO Configuration",
          "$ref": "../security/client/googleSSOClientConfig.json"
        },
        {
          "description": "Okta SSO Configuration",
          "$ref": "../security/client/oktaSSOClientConfig.json"
        },
        {
          "description": "Auth0 SSO Configuration",
          "$ref": "../security/client/auth0SSOClientConfig.json"
        },
        {
          "description": "Azure SSO Configuration",
          "$ref": "../security/client/azureSSOClientConfig.json"
        },
        {
          "description": "Custom OIDC SSO Configuration",
          "$ref": "../security/client/customOidcSSOClientConfig.json"
        },
        {
          "description": "SAML SSO Configuration",
          "$ref": "../security/client/samlSSOClientConfig.json"
        }
      ]
    }
  },
  "additionalProperties": false
}