Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Auto-update documentation for master (#72812)

github-automation-metabase5a0ecdede484
diff --git a/docs/api.json b/docs/api.json
index 0d2f394f6dd..11293010167 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -3367,20 +3367,6 @@
"required" : [ "unknown" ]
} ]
},
- "metabase.agent-api.api.aggregation" : {
- "description" : "Aggregation — count (field optional), field-based (field required), or measure-based.",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.agent-api.api.count-aggregation"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.field-aggregation"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.measure-aggregation"
- } ]
- },
- "metabase.agent-api.api.bucket" : {
- "type" : "string",
- "enum" : [ "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year", "second-of-minute", "minute-of-hour", "hour-of-day", "day-of-week", "day-of-month", "day-of-year", "week-of-year", "month-of-year", "quarter-of-year", "year-of-era" ]
- },
"metabase.agent-api.api.column-metadata" : {
"description" : "Metadata for a single result column.",
"type" : "object",
@@ -3404,51 +3390,6 @@
},
"required" : [ "name", "base_type", "display_name" ]
},
- "metabase.agent-api.api.construct-query-metric-request" : {
- "description" : "Request schema for constructing a query from a metric.\n Only supports filters and group_by (aggregation is defined by the metric).",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "filters" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.filter"
- }
- }, {
- "type" : "null"
- } ]
- },
- "group_by" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.group-by"
- }
- }, {
- "type" : "null"
- } ]
- },
- "metric_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "metric_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase.agent-api.api.construct-query-request" : {
- "description" : "Request schema for /v1/construct-query. Accepts either table_id or metric_id.",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-table-request"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-metric-request"
- } ]
- },
"metabase.agent-api.api.construct-query-response" : {
"description" : "Response containing a base64-encoded MBQL query for use with /v1/execute.",
"type" : "object",
@@ -3460,216 +3401,6 @@
},
"required" : [ "query" ]
},
- "metabase.agent-api.api.construct-query-table-request" : {
- "description" : "Request schema for constructing a query from a table.\n\n Query components:\n - filters: Filter conditions to apply\n - fields: Specific fields to select (omit for all fields)\n - aggregations: Aggregation functions (sum, count, avg, etc.). Use sort_order on the aggregation to order by it.\n - group_by: Fields to group by, with optional temporal granularity\n - order_by: Order by regular fields only. To order by an aggregation result, use sort_order on the aggregation instead.\n - limit: Maximum rows to return",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "aggregations" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.aggregation"
- }
- }, {
- "type" : "null"
- } ]
- },
- "fields" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.field"
- }
- }, {
- "type" : "null"
- } ]
- },
- "filters" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.filter"
- }
- }, {
- "type" : "null"
- } ]
- },
- "group_by" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.group-by"
- }
- }, {
- "type" : "null"
- } ]
- },
- "limit" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "order_by" : {
- "description" : "Order by regular fields only. To order by aggregation results, use sort_order on the aggregation.",
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.order-by"
- }
- }, {
- "type" : "null"
- } ]
- },
- "table_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "table_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase.agent-api.api.count-aggregation" : {
- "description" : "Count aggregation — counts rows, no field_id needed.\n Use sort_order to order results by this aggregation ('asc' or 'desc').",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "bucket" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.bucket"
- },
- "function" : {
- "const" : "count"
- },
- "sort_order" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "asc", "desc" ]
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "function" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase.agent-api.api.disjunctive-numeric-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "equals", "not-equals" ]
- },
- "values" : {
- "type" : "array",
- "items" : {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "number"
- } ]
- }
- }
- },
- "required" : [ "field_id", "operation", "values" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase.agent-api.api.disjunctive-string-date-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "equals", "not-equals", "string-contains", "string-not-contains", "string-starts-with", "string-ends-with" ]
- },
- "values" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- },
- "required" : [ "field_id", "operation", "values" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase.agent-api.api.disjunctive-temporal-extraction-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "year-equals", "year-not-equals", "quarter-equals", "quarter-not-equals", "month-equals", "month-not-equals", "day-of-week-equals", "day-of-week-not-equals", "hour-equals", "hour-not-equals", "minute-equals", "minute-not-equals", "second-equals", "second-not-equals" ]
- },
- "values" : {
- "type" : "array",
- "items" : {
- "type" : "integer"
- }
- }
- },
- "required" : [ "field_id", "operation", "values" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase.agent-api.api.disjunctive-temporal-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "bucket" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.bucket"
- },
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal" ]
- },
- "values" : {
- "type" : "array",
- "items" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "integer"
- } ]
- }
- }
- },
- "required" : [ "field_id", "operation", "values" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
"metabase.agent-api.api.entity-type" : {
"description" : "The type of queryable entity.",
"type" : "string",
@@ -3725,78 +3456,99 @@
},
"required" : [ "status" ]
},
- "metabase.agent-api.api.existence-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
+ "metabase.agent-api.api.field" : {
+ "description" : "A field from a table or metric. field_id is the real database field ID (integer) for concrete fields,\n or a string alias for expression/aggregation columns.",
+ "type" : "object",
+ "properties" : {
+ "base_type" : {
+ "oneOf" : [ {
"type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "is-null", "is-not-null", "string-is-empty", "string-is-not-empty", "is-true", "is-false" ]
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "field_id", "operation" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase.agent-api.api.field" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "bucket" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.bucket"
- },
- "field_id" : {
+ "coercion_strategy" : {
+ "oneOf" : [ {
"type" : "string"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "field_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase.agent-api.api.field-aggregation" : {
- "description" : "Aggregation using a field and function. field_id is required.\n Use sort_order to order results by this aggregation ('asc' or 'desc').",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "bucket" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.bucket"
- },
- "field_id" : {
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
"type" : "string"
- },
- "function" : {
- "type" : "string",
- "enum" : [ "avg", "count-distinct", "max", "min", "sum" ]
- },
- "sort_order" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "asc", "desc" ]
- }, {
- "type" : "null"
- } ]
- }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "field_values" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.field-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "field_id" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.field-id"
+ },
+ "effective_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "field_id", "function" ]
+ "database_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "field_id", "name", "display_name" ]
+ },
+ "metabase.agent-api.api.field-id" : {
+ "description" : "Field id as accepted by agent_api endpoints — either a real app-DB field id (positive integer)\n or a string alias for expression/aggregation columns.",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
}, {
- "type" : "object",
- "properties" : { }
+ "type" : "string"
} ]
},
+ "metabase.agent-api.api.field-type" : {
+ "description" : "A data type for a field derived from Metabase's type hierarchy.",
+ "type" : "string",
+ "enum" : [ "boolean", "date", "datetime", "time", "number", "string" ]
+ },
"metabase.agent-api.api.field-values" : {
"description" : "Statistics and sample values for a specific field.",
"type" : "object",
"properties" : {
"field_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.field-id"
}, {
"type" : "null"
} ]
@@ -3818,51 +3570,6 @@
}
}
},
- "metabase.agent-api.api.filter" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.agent-api.api.segment-filter"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.existence-filter"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.temporal-extraction-filter"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.disjunctive-temporal-extraction-filter"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.temporal-filter"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.disjunctive-temporal-filter"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.string-filter"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.disjunctive-string-date-filter"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.numeric-filter"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.disjunctive-numeric-filter"
- } ]
- },
- "metabase.agent-api.api.group-by" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_granularity" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "minute", "hour", "day", "week", "month", "quarter", "year", "day-of-week" ]
- }, {
- "type" : "null"
- } ]
- },
- "field_id" : {
- "type" : "string"
- }
- },
- "required" : [ "field_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
"metabase.agent-api.api.measure" : {
"description" : "A reusable aggregation expression associated with a table. Reference via measure_id in the aggregations array.",
"type" : "object",
@@ -3890,36 +3597,13 @@
},
"required" : [ "id", "name" ]
},
- "metabase.agent-api.api.measure-aggregation" : {
- "description" : "Aggregation using a pre-defined measure.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "measure_id" : {
- "type" : "integer"
- },
- "sort_order" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "asc", "desc" ]
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "measure_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
"metabase.agent-api.api.metric" : {
"description" : "A metric with its queryable dimensions and segments. The default_time_dimension_field_id is the field_id of the recommended time dimension for temporal breakouts.",
"type" : "object",
"properties" : {
"default_time_dimension_field_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.field-id"
}, {
"type" : "null"
} ]
@@ -3976,7 +3660,7 @@
"properties" : {
"default_time_dimension_field_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.field-id"
}, {
"type" : "null"
} ]
@@ -4000,47 +3684,12 @@
},
"required" : [ "id", "type", "name" ]
},
- "metabase.agent-api.api.numeric-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal" ]
- },
- "value" : {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "number"
- } ]
- }
- },
- "required" : [ "field_id", "operation", "value" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase.agent-api.api.order-by" : {
- "description" : "Order by item specifying a field and sort direction.",
- "type" : "object",
- "properties" : {
- "direction" : {
- "type" : "string",
- "enum" : [ "asc", "desc" ]
- },
- "field" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.field"
- }
- },
- "required" : [ "field", "direction" ]
+ "metabase.agent-api.api.program-request" : {
+ "description" : "Request body for /v2/construct-query and /v2/query.\n An agent-lib structured program with `:source` and `:operations`. The top-level\n `:source` must reference a database entity (`table`, `card`, `dataset`, or\n `metric`); `context` and nested `program` sources are rejected at the HTTP\n boundary by [[evaluate-program-for-execution]] because they require an\n in-process evaluation context.",
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.program"
},
"metabase.agent-api.api.query-request" : {
- "description" : "Request schema for /v1/query. Accepts construct params (table_id or metric_id) or a continuation_token.",
+ "description" : "Request body for /v2/query. Accepts either a structured program or a continuation_token.",
"oneOf" : [ {
"type" : "object",
"properties" : {
@@ -4051,9 +3700,7 @@
},
"required" : [ "continuation_token" ]
}, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-table-request"
- }, {
- "$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-metric-request"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.program-request"
} ]
},
"metabase.agent-api.api.query-response" : {
@@ -4275,21 +3922,6 @@
},
"required" : [ "id", "name" ]
},
- "metabase.agent-api.api.segment-filter" : {
- "description" : "Filter using a pre-defined segment.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "segment_id" : {
- "type" : "integer"
- }
- },
- "required" : [ "segment_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
"metabase.agent-api.api.statistics" : {
"description" : "Statistical summary of a field's values computed during database sync. Includes counts, percentages, numeric summaries (min/max/avg/quartiles/sd), and date ranges.",
"type" : "object",
@@ -4401,27 +4033,6 @@
}
}
},
- "metabase.agent-api.api.string-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "equals", "not-equals", "string-contains", "string-not-contains", "string-starts-with", "string-ends-with" ]
- },
- "value" : {
- "type" : "string"
- }
- },
- "required" : [ "field_id", "operation", "value" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
"metabase.agent-api.api.table" : {
"description" : "Full details of a table including its fields, related tables, metrics, and segments.",
"type" : "object",
@@ -4507,55 +4118,302 @@
},
"required" : [ "id", "type", "name", "display_name", "database_id", "database_engine", "fields" ]
},
- "metabase.agent-api.api.temporal-extraction-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "year-equals", "year-not-equals", "quarter-equals", "quarter-not-equals", "month-equals", "month-not-equals", "day-of-week-equals", "day-of-week-not-equals", "hour-equals", "hour-not-equals", "minute-equals", "minute-not-equals", "second-equals", "second-not-equals" ]
- },
- "value" : {
- "type" : "integer"
+ "metabase.agent-lib.schema.aggregation-ref-form" : {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "aggregation-ref"
+ }, {
+ "type" : "integer",
+ "minimum" : 0
+ } ]
+ },
+ "metabase.agent-lib.schema.expression-ref-form" : {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "expression-ref"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.non-blank-string"
+ } ]
+ },
+ "metabase.agent-lib.schema.form" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.source-ref"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.query-aware-ref"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.nested-operator-form"
+ } ]
+ },
+ "metabase.agent-lib.schema.map-literal" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.node"
+ }
+ },
+ "metabase.agent-lib.schema.nested-operator-form" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.node"
+ },
+ "minItems" : 1
+ },
+ "metabase.agent-lib.schema.node" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.scalar"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.program-literal"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.map-literal"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.form"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.vector-literal"
+ } ]
+ },
+ "metabase.agent-lib.schema.non-blank-string" : {
+ "type" : "string"
+ },
+ "metabase.agent-lib.schema.page" : {
+ "type" : "object",
+ "properties" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "page" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "page", "items" ],
+ "additionalProperties" : false
+ },
+ "metabase.agent-lib.schema.program" : {
+ "type" : "object",
+ "properties" : {
+ "operations" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.top-level-op"
}
},
- "required" : [ "field_id", "operation", "value" ]
+ "source" : {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.source"
+ }
+ },
+ "required" : [ "source", "operations" ],
+ "additionalProperties" : false
+ },
+ "metabase.agent-lib.schema.program-literal" : {
+ "type" : "object",
+ "properties" : {
+ "program" : {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.program"
+ },
+ "type" : {
+ "const" : "program"
+ }
+ },
+ "required" : [ "type", "program" ],
+ "additionalProperties" : false
+ },
+ "metabase.agent-lib.schema.query-aware-ref" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.expression-ref-form"
}, {
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.aggregation-ref-form"
} ]
},
- "metabase.agent-api.api.temporal-filter" : {
- "allOf" : [ {
+ "metabase.agent-lib.schema.scalar" : {
+ "anyOf" : [ {
+ "type" : "null"
+ }, {
+ "type" : "string"
+ }, {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ } ]
+ },
+ "metabase.agent-lib.schema.source" : {
+ "anyOf" : [ {
"type" : "object",
"properties" : {
- "bucket" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.bucket"
+ "ref" : {
+ "const" : "source"
},
- "field_id" : {
- "type" : "string"
+ "type" : {
+ "const" : "context"
+ }
+ },
+ "required" : [ "type", "ref" ],
+ "additionalProperties" : false
+ }, {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "operation" : {
+ "type" : {
"type" : "string",
- "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal" ]
- },
- "value" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "integer"
- } ]
+ "enum" : [ "table", "card", "dataset", "metric" ]
}
},
- "required" : [ "field_id", "operation", "value" ]
+ "required" : [ "type", "id" ],
+ "additionalProperties" : false
}, {
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.program-literal"
+ } ]
+ },
+ "metabase.agent-lib.schema.source-ref" : {
+ "anyOf" : [ {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "field"
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "table"
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "card"
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "metric"
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ } ]
} ]
},
+ "metabase.agent-lib.schema.top-level-op" : {
+ "anyOf" : [ {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.form"
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "aggregate"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.form"
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "breakout"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.form"
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "with-fields"
+ }, {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.form"
+ }
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "limit"
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "expression"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.non-blank-string"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.form"
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "join"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.form"
+ } ]
+ }, {
+ "anyOf" : [ {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "order-by"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.form"
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "order-by"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.form"
+ }, {
+ "type" : "string",
+ "enum" : [ "asc", "desc" ]
+ } ]
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "append-stage"
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "drop-stage"
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "drop-empty-stages"
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "with-page"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.page"
+ } ]
+ } ]
+ },
+ "metabase.agent-lib.schema.vector-literal" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-lib.schema.node"
+ }
+ },
"metabase.analyze.query-results.ResultsMetadata" : {
"description" : "value must be an array of valid results column metadata maps.",
"oneOf" : [ {
@@ -8838,7 +8696,7 @@
"metabase.lib.schema.info.context" : {
"description" : "Schema for `info.context`; used for informational purposes to record how a query was executed.",
"type" : "string",
- "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "transform-inspector", "slackbot" ]
+ "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "table-rows-sample", "transform-inspector", "slackbot" ]
},
"metabase.lib.schema.info.hash" : {
"type" : "string",
@@ -12974,6 +12832,13 @@
"details" : {
"type" : "object",
"properties" : {
+ "channel_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"value" : { }
},
"required" : [ "value" ],
@@ -14091,6 +13956,156 @@
"required" : [ "enabled" ]
}
},
+ "metabase.warehouses-rest.api.databases-metadata-response" : {
+ "type" : "object",
+ "properties" : {
+ "databases" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "engine" : {
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "engine" ]
+ }
+ },
+ "fields" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "base_type" : {
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "coercion_strategy" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "type" : "string"
+ },
+ "table_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ },
+ "effective_type" : {
+ "type" : "string"
+ },
+ "parent_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "database_type" : {
+ "type" : "string"
+ },
+ "description" : {
+ "type" : "string"
+ },
+ "fk_target_field_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }
+ },
+ "required" : [ "id", "table_id", "name", "base_type" ]
+ }
+ },
+ "tables" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ },
+ "description" : {
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "db_id", "name" ]
+ }
+ }
+ },
+ "required" : [ "databases", "tables", "fields" ]
+ },
+ "metabase.warehouses-rest.api.metadata-import-report" : {
+ "type" : "object",
+ "properties" : {
+ "databases" : {
+ "type" : "object",
+ "properties" : {
+ "matched" : {
+ "type" : "integer"
+ },
+ "missing" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }
+ },
+ "required" : [ "matched", "missing" ]
+ },
+ "fields" : {
+ "type" : "object",
+ "properties" : {
+ "created" : {
+ "type" : "integer"
+ },
+ "matched" : {
+ "type" : "integer"
+ },
+ "missing" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }
+ },
+ "required" : [ "matched", "created", "missing" ]
+ },
+ "tables" : {
+ "type" : "object",
+ "properties" : {
+ "created" : {
+ "type" : "integer"
+ },
+ "matched" : {
+ "type" : "integer"
+ },
+ "missing" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }
+ },
+ "required" : [ "matched", "created", "missing" ]
+ }
+ },
+ "required" : [ "databases", "tables", "fields" ]
+ },
"metabase.xrays.api.automagic-dashboards.base-64-encoded-json" : {
"description" : "form-encoded base-64-encoded JSON"
},
@@ -14605,42 +14620,6 @@
"tags" : [ "/api/activity" ]
}
},
- "/api/agent/v1/construct-query" : {
- "post" : {
- "operationId" : "post-api-agent-v1-construct-query",
- "summary" : "POST /api/agent/v1/construct-query",
- "description" : "Construct an MBQL query from a table or metric.\n\n Returns a base64-encoded MBQL query that can be used with the query API.\n\n For tables, supports: filters, fields, aggregations, group_by, order_by, limit.\n For metrics, supports: filters, group_by (aggregation is defined by the metric).",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-response"
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-request"
- }
- }
- }
- },
- "tags" : [ "/api/agent" ]
- }
- },
"/api/agent/v1/execute" : {
"post" : {
"operationId" : "post-api-agent-v1-execute",
@@ -14834,42 +14813,6 @@
"tags" : [ "/api/agent" ]
}
},
- "/api/agent/v1/query" : {
- "post" : {
- "operationId" : "post-api-agent-v1-query",
- "summary" : "POST /api/agent/v1/query",
- "description" : "Query a Metabase table or metric, or continue paginating a previous query.\n\n Accepts either construct params (table_id/metric_id + filters, aggregations, etc.)\n or a continuation_token from a previous response. Returns results with column metadata\n and an optional continuation_token for fetching the next page.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.query-response"
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.agent-api.api.query-request"
- }
- }
- }
- },
- "tags" : [ "/api/agent" ]
- }
- },
"/api/agent/v1/search" : {
"post" : {
"operationId" : "post-api-agent-v1-search",
@@ -15076,6 +15019,78 @@
"tags" : [ "/api/agent" ]
}
},
+ "/api/agent/v2/construct-query" : {
+ "post" : {
+ "operationId" : "post-api-agent-v2-construct-query",
+ "summary" : "POST /api/agent/v2/construct-query",
+ "description" : "Construct an MBQL query from a structured agent-lib program.\n\n The body is the program itself: a JSON object with `source` (identifying the\n table/card/dataset/metric to query) and `operations` (an array of operator\n tuples). Returns a base64-encoded MBQL query that can be executed via\n /v1/execute. See the agent_api reference for the full program syntax.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.program-request"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/agent" ]
+ }
+ },
+ "/api/agent/v2/query" : {
+ "post" : {
+ "operationId" : "post-api-agent-v2-query",
+ "summary" : "POST /api/agent/v2/query",
+ "description" : "Execute a structured program and stream the results, with continuation-token pagination.\n\n Accepts either a program (same shape as /v2/construct-query) or a\n `continuation_token` from a previous response. Returns results with column\n metadata and an optional `continuation_token` for fetching the next page.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.query-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.query-request"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/agent" ]
+ }
+ },
"/api/ai-entity-analysis/analyze-chart" : {
"post" : {
"operationId" : "post-api-ai-entity-analysis-analyze-chart",
@@ -21173,6 +21188,67 @@
"tags" : [ "/api/database" ]
}
},
+ "/api/database/metadata" : {
+ "get" : {
+ "operationId" : "get-api-database-metadata",
+ "summary" : "GET /api/database/metadata",
+ "description" : "Get metadata (databases, tables, and fields) for all databases visible to the current user.\n Returns a flat structure with three arrays: databases, tables, and fields.\n Response is streamed for efficiency with large schemas.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.warehouses-rest.api.databases-metadata-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/database" ]
+ },
+ "post" : {
+ "operationId" : "post-api-database-metadata",
+ "summary" : "POST /api/database/metadata",
+ "description" : "Import database/table/field metadata previously exported from `GET /api/database/metadata`.\n\n Entities are matched by natural key — databases by `(name, engine)`, tables by\n `(database, schema, name)`, fields by `(table, parent-path, name)` — so the numeric ids\n in the payload are only used to link fields to their tables within the request.\n\n Tables and fields that don't exist on the target are created when their parent\n (database for tables; table for fields) is present on the target. Databases are\n not auto-created — missing databases are reported instead. Field `fk_target_field_id`\n is re-resolved through the natural-key lookup after all fields exist.\n\n For matched entities, only user-editable metadata is written: table `description`;\n field `description`, `semantic_type`, `coercion_strategy`, `effective_type`, and\n `fk_target_field_id`. For newly-created fields, `base_type` and `database_type` are\n also populated from the payload. Keys absent from the payload (including null values)\n are left untouched on matched entities.\n\n Returns counts of matched + created entities per type plus a list of entities in the\n payload that could not be placed (their parent was missing on the target).",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.warehouses-rest.api.metadata-import-report"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.warehouses-rest.api.databases-metadata-response"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/database" ]
+ }
+ },
"/api/database/sample_database" : {
"post" : {
"operationId" : "post-api-database-sample_database",
@@ -27923,6 +27999,95 @@
"tags" : [ "/api/ee/security-center" ]
}
},
+ "/api/ee/security-center/acknowledge" : {
+ "post" : {
+ "operationId" : "post-api-ee-security-center-acknowledge",
+ "summary" : "POST /api/ee/security-center/acknowledge",
+ "description" : "Acknowledge multiple security advisories. Skips already-acknowledged advisories.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "acknowledged_at" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "acknowledged_by" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "common_name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "email" : {
+ "description" : "value must be a valid email address.",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "id", "common_name", "email" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "advisory_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.security-center.schema.advisory-id"
+ },
+ "match_status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.security-center.schema.match-status"
+ }
+ },
+ "required" : [ "advisory_id", "match_status", "acknowledged_by", "acknowledged_at" ]
+ }
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "advisory_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }
+ },
+ "required" : [ "advisory_ids" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/security-center" ]
+ }
+ },
"/api/ee/security-center/sync" : {
"post" : {
"operationId" : "post-api-ee-security-center-sync",
@@ -43622,6 +43787,13 @@
"type" : "null"
} ]
},
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"transform_name" : {
"oneOf" : [ {
"type" : "string"
@@ -43951,6 +44123,13 @@
"type" : "null"
} ]
},
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"transform_name" : {
"oneOf" : [ {
"type" : "string"
@@ -45653,6 +45832,13 @@
"type" : "null"
} ]
},
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"transform_name" : {
"oneOf" : [ {
"type" : "string"
@@ -45834,6 +46020,13 @@
"type" : "null"
} ]
},
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"transform_name" : {
"oneOf" : [ {
"type" : "string"
@@ -46014,6 +46207,13 @@
"type" : "null"
} ]
},
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"transform_name" : {
"oneOf" : [ {
"type" : "string"
@@ -46351,6 +46551,13 @@
"type" : "null"
} ]
},
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"transform_name" : {
"oneOf" : [ {
"type" : "string"
@@ -46825,6 +47032,13 @@
"type" : "null"
} ]
},
+ "metered_as" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"transform_name" : {
"oneOf" : [ {
"type" : "string"
diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.md
index 74d40411320..83eca4ecd78 100644
--- a/docs/configuring-metabase/config-template.md
+++ b/docs/configuring-metabase/config-template.md
@@ -284,6 +284,7 @@ config:
slack-connect-client-id: null
slack-connect-client-secret: null
slack-connect-enabled: false
+ slack-connect-signing-secret-version: 0
slack-connect-user-provisioning-enabled: true
smtp-override-enabled: false
source-address-header: X-Forwarded-For
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 0598244c0c5..7c214d8a4b5 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -1949,6 +1949,13 @@ Client Secret for your Slack app.
Is Slack Connect authentication configured and enabled?
+### `MB_SLACK_CONNECT_SIGNING_SECRET_VERSION`
+
+- Type: integer
+- Default: `0`
+
+Monotonically increasing version number for the Slack signing secret. Incremented each time the signing secret is rotated. Slack-connect auth identities are stamped with this version and only valid when it matches the current value. Legacy identities without a version are treated as version 0 for backwards compatibility.
+
### `MB_SLACK_CONNECT_USER_PROVISIONING_ENABLED`
- Type: boolean