# `mix ash_scim.install`
[🔗](https://github.com/ash-project/ash_scim/blob/main/lib/mix/tasks/ash_scim.install.ex#L7)

Installs AshScim. Invoke with `mix igniter.install ash_scim`

Wires `AshScim.User` onto your user resource, adds the standard SCIM
mapping defaults, ensures the router-bypass policy is present, and
generates a SCIM router module. The installer is idempotent — re-running
it on a partially-installed app picks up where it left off.

The endpoint plug that forwards `/scim/v2/*` to the generated router
isn't auto-wired — SCIM URLs include `:` in schema IDs which Phoenix's
`Plug.Static` rejects, so the dispatch needs to live above
`Plug.Static` in the endpoint pipeline. The installer prints the exact
snippet to paste into your `Endpoint` module after it runs.

## Examples

```bash
mix igniter.install ash_scim
```

```bash
mix igniter.install ash_scim --user MyApp.Accounts.User --router MyAppWeb.ScimRouter
```

## Options

* `--accounts` or `-a` — the domain that contains your user resource.
  Defaults to `YourApp.Accounts`.
* `--user` or `-u` — the user resource. Defaults to `<accounts>.User`.
* `--router` or `-r` — the SCIM router module to generate.
  Defaults to `<web_module>.ScimRouter`, falling back to
  `<accounts>.ScimRouter` when no Phoenix web module is present.

---

*Consult [api-reference.md](api-reference.md) for complete listing*