metabase / metabase/metabase

Support defining SCIM token via config file

Open
#72,235 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

.Auto triaged .Team/UXWest Administration/Settings Type:New Feature
Dominant language
Clojure
Stars
49.3k
Forks
6.8k
Avg merge
1d 13h
Merged PRs (30d)
653

Description

**What problem will this feature request solve?**

Currently, enabling SCIM is a 2-step process:

1. Go to Admin > Authentication > User provisioning > Enable SCIM (or, set `scim-enabled: true` in the config file)
2. Generate and save a SCIM token

Step 2 always requires a manual click or API call. There is no config file preference or environment variable to define the SCIM token.

It's currently possible to define API keys in the config file like so:

```yaml
config:
api-keys:
- name: My API key
group: admin
creator: foo@example.com
key: mb_thisismyapikey
```

However this cannot be used for SCIM tokens specifically. SCIM tokens are stored in the `api_key` table, with a value of `scim` in the `scope` column. This cannot be passed via config file.

**Describe the solution you'd like.**

Allow some way of defining SCIM tokens via config file. Example:

```yaml
config:
scim-enabled: true
api-keys:
- name: My SCIM token
creator: foo@example.com
scope: scim
key: mb_thisismyscimtoken
```

**How does this feature request impact you?**

Inconvenient for fully-automated/replicated setups. Config file feels incomplete when it cannot be used to fully enable SCIM.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing config.api-keys handling and api_key table persistence, then compare how scim-enabled and the scim API-key scope are processed. Done means a SCIM token can be defined in the config file for automated setups, with behavior covered by the relevant configuration and token tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
authentication
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.