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 (#78062)

github-automation-metabasef5bbb2bfdedb
diff --git a/docs/api.json b/docs/api.json
index 6d8d53ca0fb..1058da30322 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -25642,7 +25642,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "metabase-ai", "metabase-ai-tiered", "metabase-ai-managed", "python-execution", "transforms", "transforms-basic", "transforms-advanced", "transforms-basic-metered", "transforms-advanced-metered", "dwh-rent", "etl-connections" ]
+ "enum" : [ "metabase-ai", "metabase-ai-tiered", "metabase-ai-managed", "python-execution", "transforms", "transforms-basic", "transforms-advanced", "transforms-basic-metered", "transforms-advanced-metered" ]
}
} ],
"responses" : {
@@ -25693,7 +25693,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "metabase-ai", "metabase-ai-tiered", "metabase-ai-managed", "python-execution", "transforms", "transforms-basic", "transforms-advanced", "transforms-basic-metered", "transforms-advanced-metered", "dwh-rent", "etl-connections" ]
+ "enum" : [ "metabase-ai", "metabase-ai-tiered", "metabase-ai-managed", "python-execution", "transforms", "transforms-basic", "transforms-advanced", "transforms-basic-metered", "transforms-advanced-metered" ]
}
} ],
"responses" : {
@@ -28948,7 +28948,7 @@
"post" : {
"operationId" : "post-api-ee-mfa-admin-remove",
"summary" : "POST /api/ee/mfa/admin/remove",
- "description" : "Admin: remove a user's two-factor enrollment entirely — the lockout escape hatch for a lost\n authenticator with no recovery codes. Never feature-gated (a lapsed license must not make\n lockouts permanent). The affected user is notified by email. They re-enroll from scratch —\n there is nothing to \"reset\", the secret lives on their device.",
+ "description" : "Admin: remove *another* user's two-factor enrollment entirely — the lockout escape hatch for a\n lost authenticator with no recovery codes. Never feature-gated (a lapsed license must not make\n lockouts permanent). The affected user is notified by email. They re-enroll from scratch — there\n is nothing to \"reset\", the secret lives on their device.\n\n Removing your *own* enrollment is deliberately refused here: this is a user-management endpoint\n that takes no second factor (the target can't produce one — that's why an admin is removing it),\n and the admin UI never collects a code. Self-removal goes through the normal Security page, which\n re-auths with a fresh factor via `/disable`. Without this guard a hijacked admin session could\n strip its own 2FA with only a cookie, turning transient access into a permanent password bypass.",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -33742,7 +33742,7 @@
"delete" : {
"operationId" : "delete-api-ee-workspace-manager-id",
"summary" : "DELETE /api/ee/workspace-manager/{id}",
- "description" : "Delete a Workspace. Tears down each `:provisioned` database's warehouse isolation\n first (blocking). Refuses with a 409 if any database is still `:provisioning`/\n `:deprovisioning` unless `ignore_pending=true`, in which case those databases are\n left in the warehouse and only their app-DB rows are removed. If the warehouse was\n unreachable for some `:provisioned` databases, the response includes\n `:orphaned_resources` and a `:message` describing the inert schema/user objects\n left behind for manual cleanup.",
+ "description" : "Delete a Workspace. Tears down every database's warehouse isolation first\n (blocking, any state). Each database is either fully torn down (its row is\n deleted) or kept; when any teardown fails the workspace is kept too — with the\n failed rows, so the delete can be retried — and the combined failure is\n returned as the error. 204 on success, no response body.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -33752,18 +33752,6 @@
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
- }, {
- "in" : "query",
- "name" : "ignore-pending",
- "required" : false,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
} ],
"responses" : {
"2XX" : {
@@ -33771,56 +33759,7 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "deleted" : {
- "type" : "boolean"
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "message" : {
- "type" : "string"
- },
- "orphaned_resources" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "driver" : {
- "type" : "string"
- },
- "reason" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "schema" : {
- "type" : "string"
- },
- "user" : {
- "type" : "string"
- },
- "workspace_database_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "workspace_database_id", "database_id", "driver", "schema", "user" ]
- }
- }
- },
- "required" : [ "id", "deleted" ]
+ "type" : "null"
}
}
}
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 600f6bf5e06..7bb5a98ca6c 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -1881,8 +1881,7 @@ on your IdP, this usually looks something like `http://www.example.com/141xkex60
- Default: `null`
- [Configuration file name](./config-file.md): `saml-identity-provider-slo-uri`
-This is the URL where your users go to logout of your identity provider. Depending on which IdP you're
-using, this usually looks like `https://your-org-name.example.com` or `https://example.com/app/my_saml_app/abc123/sso/slo`.
+If SAML single logout (SLO) is enabled, Metabase will make an HTTP-Redirect SLO request to this endpoint when a user logs out of Metabase.
### `MB_SAML_IDENTITY_PROVIDER_URI`
@@ -1933,7 +1932,7 @@ Absolute path to the Keystore file to use for signing SAML requests.
- Default: `false`
- [Configuration file name](./config-file.md): `saml-slo-enabled`
-Is SAML Single Log Out enabled?
+If enabled, Metabase will redirect users to your configured SAML Single Logout endpoint when they log out of Metabase.
### `MB_SAML_USER_PROVISIONING_ENABLED`