@seliseblocks/cli-os 0.2.2 → 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AI_USAGE_GUIDE.md +551 -546
- package/LICENSE +21 -21
- package/README.md +171 -171
- package/bin/run.js +2 -2
- package/dist/commands/data/files/delete.js +5 -4
- package/dist/commands/data/files/get-many.js +1 -1
- package/dist/commands/data/files/get.js +1 -1
- package/dist/commands/data/files/info.js +1 -1
- package/dist/commands/data/files/object-tree.d.ts +23 -0
- package/dist/commands/data/files/object-tree.js +238 -0
- package/dist/commands/data/files/presigned-upload-url.js +9 -2
- package/dist/commands/data/files/update-additional-info.js +2 -2
- package/dist/commands/data/files/upload-to-local-storage.js +2 -2
- package/dist/commands/data/files/upload.d.ts +2 -4
- package/dist/commands/data/files/upload.js +14 -28
- package/dist/index.js +685 -647
- package/dist/skills/blocks-data-gateway-configuration/SKILL.md +204 -204
- package/dist/skills/blocks-data-gateway-crud/SKILL.md +223 -223
- package/dist/skills/blocks-data-storage/SKILL.md +253 -161
- package/dist/skills/blocks-data-storage/flows/object-management.md +124 -0
- package/dist/skills/blocks-frontend-local-https/SKILL.md +100 -100
- package/dist/skills/blocks-iam-account/SKILL.md +169 -169
- package/dist/skills/blocks-iam-sso-oidc-implementation/SKILL.md +80 -80
- package/dist/skills/blocks-iam-users/SKILL.md +131 -131
- package/dist/skills/blocks-localization-configuration/SKILL.md +149 -149
- package/dist/skills/blocks-localization-implementation/SKILL.md +63 -63
- package/dist/skills/blocks-onboarding/SKILL.md +77 -77
- package/dist/skills/blocks-storage-configuration/SKILL.md +4 -4
- package/package.json +47 -47
- package/dist/commands/data/files/create-folder.d.ts +0 -1
- package/dist/commands/data/files/create-folder.js +0 -34
- package/dist/commands/data/files/delete-folder.d.ts +0 -1
- package/dist/commands/data/files/delete-folder.js +0 -25
- package/dist/commands/data/files/dms-list.d.ts +0 -1
- package/dist/commands/data/files/dms-list.js +0 -27
- package/dist/commands/data/files/dms-upload.d.ts +0 -6
- package/dist/commands/data/files/dms-upload.js +0 -41
|
@@ -1,100 +1,100 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: blocks-frontend-local-https
|
|
3
|
-
description: "Run a scaffolded (`blocks new web`) Blocks app locally over HTTPS on its real project domain — required for hosted IAM login, since plain HTTP or localhost never gets the session cookie. The scaffold already automates cert generation (npm run cert, no OpenSSL needed) and HTTPS serving via vite.config.ts. Covers running that flow, trusting the cert, the hosts-file entry, and troubleshooting. Use when running a scaffolded app over HTTPS, hitting 'SSO cookie not set' / Vite 'Blocked request' errors, trusting the dev cert, or asking why local login redirects back but doesn't stay signed in."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Blocks Frontend — Local HTTPS for a Scaffolded App
|
|
7
|
-
|
|
8
|
-
This is the local dev loop for an app already created with `blocks new web` (see the blocks-onboarding skill for the scaffold command itself — this skill doesn't repeat it). The scaffold **already generates its own cert tooling**; nothing here is built from scratch, and nothing uses raw `openssl`/`curl`/`fetch`.
|
|
9
|
-
|
|
10
|
-
## Why localhost doesn't work
|
|
11
|
-
|
|
12
|
-
Browser login goes through the hosted Blocks IAM IdP flow (`blocksClient.auth.idp.redirectToProvider()` / `.callback()`), which finishes by IAM setting a **Secure, domain-scoped session cookie**. Browsers won't store or send that cookie on plain `http://localhost` — it has to be HTTPS, and it has to be on the project's real domain, or the cookie silently never lands and the app looks "logged in" for a second then bounces back to logged-out.
|
|
13
|
-
|
|
14
|
-
## Where the domain comes from
|
|
15
|
-
|
|
16
|
-
`--app-domain` on `blocks new web` is the app's real Blocks origin, e.g. `https://dbpdba.seliseblocks.com`. The generated `.env` keeps two derived values:
|
|
17
|
-
|
|
18
|
-
- `VITE_BLOCKS_APP_DOMAIN` — the full value as passed, with scheme (`https://dbpdba.seliseblocks.com`).
|
|
19
|
-
- `VITE_BLOCKS_DEV_HOST` — the same host with no scheme (`dbpdba.seliseblocks.com`), computed by the scaffold generator and used everywhere locally: hosts file, cert `commonName`/SAN, and `vite.config.ts`'s `server.host`/`allowedHosts`.
|
|
20
|
-
|
|
21
|
-
You never need to look this up separately — it's already sitting in `.env` after scaffolding.
|
|
22
|
-
|
|
23
|
-
## The flow
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
cd <appName>
|
|
27
|
-
npm install
|
|
28
|
-
npm run cert
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
`npm run cert` runs `scripts/generate-cert.mjs`, which reads `VITE_BLOCKS_DEV_HOST` from `.env` (or `process.env`, or an explicit `npm run cert -- <domain>` argument) and uses the `selfsigned` npm dependency to write `.cert/dev-key.pem` and `.cert/dev-cert.pem`, with `subjectAltName` covering the domain, `localhost`, and `127.0.0.1`. This is pure Node — it works from a plain PowerShell prompt with no OpenSSL and no Git Bash/WSL switch.
|
|
32
|
-
|
|
33
|
-
Next, map the domain to your machine — add one line to the hosts file (needs admin/elevated):
|
|
34
|
-
|
|
35
|
-
```text
|
|
36
|
-
127.0.0.1 dbpdba.seliseblocks.com
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
Windows path: `C:\Windows\System32\drivers\etc\hosts` (edit as Administrator).
|
|
40
|
-
|
|
41
|
-
Then:
|
|
42
|
-
|
|
43
|
-
```bash
|
|
44
|
-
npm run dev
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
`vite.config.ts` picks up `.cert/dev-key.pem` + `.cert/dev-cert.pem` automatically when both exist and serves HTTPS on `VITE_BLOCKS_DEV_HOST`:`VITE_BLOCKS_DEV_PORT` (default port `5173`, `strictPort: true` because the port is baked into the registered OIDC redirect URI). It also sets `allowedHosts` to that domain, working around Vite's default DNS-rebinding protection which otherwise 404s custom hosts with "Blocked request."
|
|
48
|
-
|
|
49
|
-
Finally, open the app at:
|
|
50
|
-
|
|
51
|
-
```text
|
|
52
|
-
https://dbpdba.seliseblocks.com:5173
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
**Not** `http://`, **not** `localhost` — either one skips the cookie entirely even though the app loads.
|
|
56
|
-
|
|
57
|
-
## Trusting the cert (optional but recommended)
|
|
58
|
-
|
|
59
|
-
The cert is self-signed, so the browser shows a one-time warning until trusted. `npm run cert` prints the exact trust command for your OS when it finishes:
|
|
60
|
-
|
|
61
|
-
- Windows (elevated prompt): `certutil -addstore -f Root .cert\dev-cert.pem`
|
|
62
|
-
- macOS: `sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain .cert/dev-cert.pem`
|
|
63
|
-
- Linux: `sudo cp .cert/dev-cert.pem /usr/local/share/ca-certificates/blocks-dev.crt && sudo update-ca-certificates`
|
|
64
|
-
|
|
65
|
-
Restart the browser after trusting so it picks up the new trust store entry. `.cert/` is already gitignored by the scaffold — it's per-machine, never committed.
|
|
66
|
-
|
|
67
|
-
## Still need a public OIDC client
|
|
68
|
-
|
|
69
|
-
Local HTTPS alone doesn't make login succeed if no OIDC client is registered yet, or if its `redirect_uris` don't include this exact dev origin. That registration is portal-only (see blocks-onboarding's Gotchas) — out of scope here, but it's the next thing to check if HTTPS is right and login still fails. The redirect URI must match byte-for-byte, including `:5173`.
|
|
70
|
-
|
|
71
|
-
## Gotchas
|
|
72
|
-
|
|
73
|
-
**Custom app domain: the API base URL must share its registrable domain, or the cookie never lands.** `blocks new web --app-domain` isn't limited to `*.seliseblocks.com` — it also supports custom domains (e.g. `abc.slsblx.com`, `xyz.blx10.com`). On a custom domain, the hosted-login session cookie is only stored by the browser if `VITE_BLOCKS_API_URL` shares the app's registrable domain. Concretely:
|
|
74
|
-
|
|
75
|
-
- `abc.slsblx.com` → `VITE_BLOCKS_API_URL` must be `https://blocksapi.slsblx.com`
|
|
76
|
-
- `xyz.blx10.com` → `VITE_BLOCKS_API_URL` must be `https://blocksapi.blx10.com`
|
|
77
|
-
|
|
78
|
-
If `VITE_BLOCKS_API_URL` is left at the default `https://api.seliseblocks.com` while the app itself runs on a custom domain, the browser treats the API as cross-site relative to the app and never stores the cookie — login still redirects back and *looks* successful, but cookie-based calls (`/iam/me`, organization switching, logout) silently fail. Check `VITE_BLOCKS_API_URL` in `.env` first whenever the app domain is not `*.seliseblocks.com` and auth-dependent calls are failing despite HTTPS and the cert being set up correctly.
|
|
79
|
-
|
|
80
|
-
## Troubleshooting
|
|
81
|
-
|
|
82
|
-
| Symptom | Likely cause | Fix |
|
|
83
|
-
|---|---|---|
|
|
84
|
-
| Login redirects back but app shows logged-out | Opened on `http://` or `localhost` instead of the HTTPS dev host | Check the URL bar: must be `https://<VITE_BLOCKS_DEV_HOST>:5173` exactly |
|
|
85
|
-
| Browser "not private" warning | Self-signed cert not trusted yet | Run the OS trust command `npm run cert` printed, then restart the browser |
|
|
86
|
-
| Vite: "Blocked request. This host is not allowed" | `allowedHosts` doesn't include the host being requested — usually `.env`'s `VITE_BLOCKS_DEV_HOST` was edited/missing after scaffold, or the browser is hitting a different hostname than expected | Confirm `.env` has the right `VITE_BLOCKS_DEV_HOST` and that the URL bar matches it exactly |
|
|
87
|
-
| Page doesn't load at all / DNS error | Hosts file entry missing or wrong | Add `127.0.0.1 <VITE_BLOCKS_DEV_HOST>` to `C:\Windows\System32\drivers\etc\hosts` (as Administrator) |
|
|
88
|
-
| `npm run cert` errors "No domain given" | `.env` missing or `VITE_BLOCKS_DEV_HOST` not set | Confirm `.env` exists with `VITE_BLOCKS_DEV_HOST=<host>`, or run `npm run cert -- <domain>` explicitly |
|
|
89
|
-
| `npm run dev` fails to bind the port | Port 5173 already in use (dev server uses `strictPort`, won't fall back) | Free port 5173, or the port is fixed because it's part of the registered OIDC redirect URI — don't just change it without updating the OIDC client too |
|
|
90
|
-
| HTTPS works, cert trusted, login still fails | No OIDC client registered yet, or its redirect URI doesn't match this origin exactly | Register/update the public OIDC client in the portal with `https://<VITE_BLOCKS_DEV_HOST>:5173/login/callback` as a redirect URI (portal-only, see blocks-onboarding) |
|
|
91
|
-
| Works for one dev, fails for a teammate | Each machine needs its own cert + hosts entry — `.cert/` is gitignored on purpose | Teammate runs `npm run cert` and adds the hosts entry on their own machine |
|
|
92
|
-
|
|
93
|
-
## Example trigger prompts
|
|
94
|
-
|
|
95
|
-
- "Run my app locally over HTTPS on its real domain so SSO works"
|
|
96
|
-
- "My local login isn't working — it just bounces back to the login page"
|
|
97
|
-
- "How do I set up the dev cert for this scaffolded app?"
|
|
98
|
-
- "I'm getting 'Blocked request. This host is not allowed' from Vite"
|
|
99
|
-
- "Do I need OpenSSL to run npm run cert on Windows?"
|
|
100
|
-
- "Why does login work in production but not on localhost?"
|
|
1
|
+
---
|
|
2
|
+
name: blocks-frontend-local-https
|
|
3
|
+
description: "Run a scaffolded (`blocks new web`) Blocks app locally over HTTPS on its real project domain — required for hosted IAM login, since plain HTTP or localhost never gets the session cookie. The scaffold already automates cert generation (npm run cert, no OpenSSL needed) and HTTPS serving via vite.config.ts. Covers running that flow, trusting the cert, the hosts-file entry, and troubleshooting. Use when running a scaffolded app over HTTPS, hitting 'SSO cookie not set' / Vite 'Blocked request' errors, trusting the dev cert, or asking why local login redirects back but doesn't stay signed in."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Blocks Frontend — Local HTTPS for a Scaffolded App
|
|
7
|
+
|
|
8
|
+
This is the local dev loop for an app already created with `blocks new web` (see the blocks-onboarding skill for the scaffold command itself — this skill doesn't repeat it). The scaffold **already generates its own cert tooling**; nothing here is built from scratch, and nothing uses raw `openssl`/`curl`/`fetch`.
|
|
9
|
+
|
|
10
|
+
## Why localhost doesn't work
|
|
11
|
+
|
|
12
|
+
Browser login goes through the hosted Blocks IAM IdP flow (`blocksClient.auth.idp.redirectToProvider()` / `.callback()`), which finishes by IAM setting a **Secure, domain-scoped session cookie**. Browsers won't store or send that cookie on plain `http://localhost` — it has to be HTTPS, and it has to be on the project's real domain, or the cookie silently never lands and the app looks "logged in" for a second then bounces back to logged-out.
|
|
13
|
+
|
|
14
|
+
## Where the domain comes from
|
|
15
|
+
|
|
16
|
+
`--app-domain` on `blocks new web` is the app's real Blocks origin, e.g. `https://dbpdba.seliseblocks.com`. The generated `.env` keeps two derived values:
|
|
17
|
+
|
|
18
|
+
- `VITE_BLOCKS_APP_DOMAIN` — the full value as passed, with scheme (`https://dbpdba.seliseblocks.com`).
|
|
19
|
+
- `VITE_BLOCKS_DEV_HOST` — the same host with no scheme (`dbpdba.seliseblocks.com`), computed by the scaffold generator and used everywhere locally: hosts file, cert `commonName`/SAN, and `vite.config.ts`'s `server.host`/`allowedHosts`.
|
|
20
|
+
|
|
21
|
+
You never need to look this up separately — it's already sitting in `.env` after scaffolding.
|
|
22
|
+
|
|
23
|
+
## The flow
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
cd <appName>
|
|
27
|
+
npm install
|
|
28
|
+
npm run cert
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
`npm run cert` runs `scripts/generate-cert.mjs`, which reads `VITE_BLOCKS_DEV_HOST` from `.env` (or `process.env`, or an explicit `npm run cert -- <domain>` argument) and uses the `selfsigned` npm dependency to write `.cert/dev-key.pem` and `.cert/dev-cert.pem`, with `subjectAltName` covering the domain, `localhost`, and `127.0.0.1`. This is pure Node — it works from a plain PowerShell prompt with no OpenSSL and no Git Bash/WSL switch.
|
|
32
|
+
|
|
33
|
+
Next, map the domain to your machine — add one line to the hosts file (needs admin/elevated):
|
|
34
|
+
|
|
35
|
+
```text
|
|
36
|
+
127.0.0.1 dbpdba.seliseblocks.com
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Windows path: `C:\Windows\System32\drivers\etc\hosts` (edit as Administrator).
|
|
40
|
+
|
|
41
|
+
Then:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm run dev
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
`vite.config.ts` picks up `.cert/dev-key.pem` + `.cert/dev-cert.pem` automatically when both exist and serves HTTPS on `VITE_BLOCKS_DEV_HOST`:`VITE_BLOCKS_DEV_PORT` (default port `5173`, `strictPort: true` because the port is baked into the registered OIDC redirect URI). It also sets `allowedHosts` to that domain, working around Vite's default DNS-rebinding protection which otherwise 404s custom hosts with "Blocked request."
|
|
48
|
+
|
|
49
|
+
Finally, open the app at:
|
|
50
|
+
|
|
51
|
+
```text
|
|
52
|
+
https://dbpdba.seliseblocks.com:5173
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
**Not** `http://`, **not** `localhost` — either one skips the cookie entirely even though the app loads.
|
|
56
|
+
|
|
57
|
+
## Trusting the cert (optional but recommended)
|
|
58
|
+
|
|
59
|
+
The cert is self-signed, so the browser shows a one-time warning until trusted. `npm run cert` prints the exact trust command for your OS when it finishes:
|
|
60
|
+
|
|
61
|
+
- Windows (elevated prompt): `certutil -addstore -f Root .cert\dev-cert.pem`
|
|
62
|
+
- macOS: `sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain .cert/dev-cert.pem`
|
|
63
|
+
- Linux: `sudo cp .cert/dev-cert.pem /usr/local/share/ca-certificates/blocks-dev.crt && sudo update-ca-certificates`
|
|
64
|
+
|
|
65
|
+
Restart the browser after trusting so it picks up the new trust store entry. `.cert/` is already gitignored by the scaffold — it's per-machine, never committed.
|
|
66
|
+
|
|
67
|
+
## Still need a public OIDC client
|
|
68
|
+
|
|
69
|
+
Local HTTPS alone doesn't make login succeed if no OIDC client is registered yet, or if its `redirect_uris` don't include this exact dev origin. That registration is portal-only (see blocks-onboarding's Gotchas) — out of scope here, but it's the next thing to check if HTTPS is right and login still fails. The redirect URI must match byte-for-byte, including `:5173`.
|
|
70
|
+
|
|
71
|
+
## Gotchas
|
|
72
|
+
|
|
73
|
+
**Custom app domain: the API base URL must share its registrable domain, or the cookie never lands.** `blocks new web --app-domain` isn't limited to `*.seliseblocks.com` — it also supports custom domains (e.g. `abc.slsblx.com`, `xyz.blx10.com`). On a custom domain, the hosted-login session cookie is only stored by the browser if `VITE_BLOCKS_API_URL` shares the app's registrable domain. Concretely:
|
|
74
|
+
|
|
75
|
+
- `abc.slsblx.com` → `VITE_BLOCKS_API_URL` must be `https://blocksapi.slsblx.com`
|
|
76
|
+
- `xyz.blx10.com` → `VITE_BLOCKS_API_URL` must be `https://blocksapi.blx10.com`
|
|
77
|
+
|
|
78
|
+
If `VITE_BLOCKS_API_URL` is left at the default `https://api.seliseblocks.com` while the app itself runs on a custom domain, the browser treats the API as cross-site relative to the app and never stores the cookie — login still redirects back and *looks* successful, but cookie-based calls (`/iam/me`, organization switching, logout) silently fail. Check `VITE_BLOCKS_API_URL` in `.env` first whenever the app domain is not `*.seliseblocks.com` and auth-dependent calls are failing despite HTTPS and the cert being set up correctly.
|
|
79
|
+
|
|
80
|
+
## Troubleshooting
|
|
81
|
+
|
|
82
|
+
| Symptom | Likely cause | Fix |
|
|
83
|
+
|---|---|---|
|
|
84
|
+
| Login redirects back but app shows logged-out | Opened on `http://` or `localhost` instead of the HTTPS dev host | Check the URL bar: must be `https://<VITE_BLOCKS_DEV_HOST>:5173` exactly |
|
|
85
|
+
| Browser "not private" warning | Self-signed cert not trusted yet | Run the OS trust command `npm run cert` printed, then restart the browser |
|
|
86
|
+
| Vite: "Blocked request. This host is not allowed" | `allowedHosts` doesn't include the host being requested — usually `.env`'s `VITE_BLOCKS_DEV_HOST` was edited/missing after scaffold, or the browser is hitting a different hostname than expected | Confirm `.env` has the right `VITE_BLOCKS_DEV_HOST` and that the URL bar matches it exactly |
|
|
87
|
+
| Page doesn't load at all / DNS error | Hosts file entry missing or wrong | Add `127.0.0.1 <VITE_BLOCKS_DEV_HOST>` to `C:\Windows\System32\drivers\etc\hosts` (as Administrator) |
|
|
88
|
+
| `npm run cert` errors "No domain given" | `.env` missing or `VITE_BLOCKS_DEV_HOST` not set | Confirm `.env` exists with `VITE_BLOCKS_DEV_HOST=<host>`, or run `npm run cert -- <domain>` explicitly |
|
|
89
|
+
| `npm run dev` fails to bind the port | Port 5173 already in use (dev server uses `strictPort`, won't fall back) | Free port 5173, or the port is fixed because it's part of the registered OIDC redirect URI — don't just change it without updating the OIDC client too |
|
|
90
|
+
| HTTPS works, cert trusted, login still fails | No OIDC client registered yet, or its redirect URI doesn't match this origin exactly | Register/update the public OIDC client in the portal with `https://<VITE_BLOCKS_DEV_HOST>:5173/login/callback` as a redirect URI (portal-only, see blocks-onboarding) |
|
|
91
|
+
| Works for one dev, fails for a teammate | Each machine needs its own cert + hosts entry — `.cert/` is gitignored on purpose | Teammate runs `npm run cert` and adds the hosts entry on their own machine |
|
|
92
|
+
|
|
93
|
+
## Example trigger prompts
|
|
94
|
+
|
|
95
|
+
- "Run my app locally over HTTPS on its real domain so SSO works"
|
|
96
|
+
- "My local login isn't working — it just bounces back to the login page"
|
|
97
|
+
- "How do I set up the dev cert for this scaffolded app?"
|
|
98
|
+
- "I'm getting 'Blocked request. This host is not allowed' from Vite"
|
|
99
|
+
- "Do I need OpenSSL to run npm run cert on Windows?"
|
|
100
|
+
- "Why does login work in production but not on localhost?"
|
|
@@ -1,169 +1,169 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: blocks-iam-account
|
|
3
|
-
description: "Signed-in (or partially-signed-in) user's own SELISE Blocks IAM account actions via @seliseblocks/client — never raw fetch/curl. Covers activation, forgot/reset/change password, logout(-all), profile bootstrap (iam.me/updateMe), self-service MFA, signup, and login-options discovery. Use for activation/password pages, logout buttons, profile bootstrap, signup forms, or letting a user manage their own MFA. The self-service half of IAM — not admin CRUD on other users (blocks-iam-users/blocks-iam-access-control), not hosted-login redirect (blocks-iam-sso-oidc-implementation)."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Blocks IAM — Account Self-Service
|
|
7
|
-
|
|
8
|
-
Account-lifecycle and account-security actions the signed-in (or not-yet-fully-signed-in) user takes on **their own** account, all through the single `@seliseblocks/client` instance the scaffold gives you — `blocks new web` wires up `createBlocksClient({ apiUrl, xBlocksKey, oidc, accessToken })` once; every call below hangs off that instance's `.auth`, `.iam`, or `.mfa` namespace. **Never** hand-roll `fetch`/`curl` against `api.seliseblocks.com` for these.
|
|
9
|
-
|
|
10
|
-
Source of truth: `auth-client.ts`, `iam-client.ts`, and `mfa-client.ts` in `@seliseblocks/client`. Every method has a What/Why/How docstring in source — this skill surfaces them, it doesn't add new ones.
|
|
11
|
-
|
|
12
|
-
## Scope: this vs. the other IAM skills
|
|
13
|
-
|
|
14
|
-
- **This skill** — the current user acting on themselves: activate their own invite, reset their own forgotten password, change their own password, log themselves out, read/edit their own profile, sign up, discover login options, enroll/manage their own MFA.
|
|
15
|
-
- **blocks-iam-users / blocks-iam-access-control** — an admin managing *other* users (create, deactivate, grant/revoke access). Different actor, different skill. Don't duplicate that here.
|
|
16
|
-
- **blocks-iam-sso-oidc-implementation** — the hosted-login redirect/callback flow (`auth.idp.initiate`/`redirectToProvider`/`callback`, `oidc.refreshToken`). This skill only covers direct account-lifecycle calls (activate, recover, reset, change-password, logout) that a user takes outside that redirect dance — don't reimplement hosted login here.
|
|
17
|
-
- **blocks-iam-mfa** (not yet written) — the full self-service MFA walkthrough (enrollment UX, challenge flows, backup codes). This skill only notes that `mfa.*` exists and is in scope; go there for depth.
|
|
18
|
-
|
|
19
|
-
## The SDK never owns your session
|
|
20
|
-
|
|
21
|
-
Every method here just relays IAM's request/response. The SDK **does not** read or write cookies, localStorage, or any token store — your app decides where the access token, refresh token, and "am I logged in" flag live, and passes the access token in via the `accessToken` option (string or async callback) on `createBlocksClient`. After `logout`/`logoutAll`, activation, or a password reset, **you** clear/update that app-owned state; the SDK call alone doesn't do it for you.
|
|
22
|
-
|
|
23
|
-
Request/payload types for most of these methods are intentionally loose (`Record<string, unknown>` passthrough — IAM, not the SDK, defines the exact fields). `BlocksLogoutRequest` is the one exception with a typed hint (`refreshToken?: string`). Where the SDK doesn't pin the shape, confirm exact field names against your tenant's IAM contract rather than guessing — the examples below show the well-known fields, not an exhaustive schema.
|
|
24
|
-
|
|
25
|
-
## Activation — finishing account setup
|
|
26
|
-
|
|
27
|
-
Three related calls, all under `blocksClient.auth`, all public (no bearer token needed for `activate`/`validateActivation` — the emailed code is the credential):
|
|
28
|
-
|
|
29
|
-
- **`auth.validateActivation(request)`** — no auth required. Check the activation code/state *before* showing the final "set your password" step, so an expired/invalid link fails fast with a clear message instead of after the user fills out the form.
|
|
30
|
-
- **`auth.activate(request)`** — no auth required. Completes setup for a user created/invited in an inactive state: pass the emailed `code` plus the new password (and whatever else your tenant's activation contract needs, e.g. `firstName`/`lastName`) after your UI confirms password === confirm-password client-side (don't send a confirm field — that's a UI-only check).
|
|
31
|
-
- **`auth.resendActivation(request)`** — Send a new code/link when the old one expired. This call attaches the bearer token if one happens to be configured, but works either way — typical callers are not-yet-active, so don't gate this behind requiring a token.
|
|
32
|
-
|
|
33
|
-
```ts
|
|
34
|
-
// after the user opens /activate?code=... and submits password + confirm
|
|
35
|
-
const state = await blocksClient.auth.validateActivation({ code });
|
|
36
|
-
if (!state.valid) {
|
|
37
|
-
// show "this link expired" + a resend option
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
await blocksClient.auth.activate({
|
|
41
|
-
code,
|
|
42
|
-
password,
|
|
43
|
-
firstName,
|
|
44
|
-
lastName
|
|
45
|
-
});
|
|
46
|
-
// account is now active — route to login / hosted-login (blocks-iam-sso-oidc-implementation)
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
## Password — forgot, reset, and authenticated change
|
|
50
|
-
|
|
51
|
-
- **`auth.recover(request)`** — no auth required. Public entry point for "forgot password" — typically just the account's email. Triggers IAM to send a reset link/code.
|
|
52
|
-
- **`auth.resetPassword(request)`** — no auth required. Completes the recovery: pass the emailed reset token plus the new password. IAM owns token validation and password-policy enforcement — surface its response/errors directly rather than pre-validating password rules yourself.
|
|
53
|
-
- **`auth.changePassword(request)`** — requires an access token (an authenticated account-security action, not part of the recovery flow). Use this for a signed-in "change my password" settings-page action — current password + new password.
|
|
54
|
-
|
|
55
|
-
```ts
|
|
56
|
-
// forgot-password page
|
|
57
|
-
await blocksClient.auth.recover({ email });
|
|
58
|
-
|
|
59
|
-
// reset-password page (link from the recovery email)
|
|
60
|
-
await blocksClient.auth.resetPassword({ code, password: newPassword });
|
|
61
|
-
|
|
62
|
-
// signed-in settings page
|
|
63
|
-
await blocksClient.auth.changePassword({ oldPassword, newPassword });
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
## Logout — end this session or all sessions
|
|
67
|
-
|
|
68
|
-
- **`auth.logout(request = {})`** — Ends the current session; commonly takes `{ refreshToken }` if your app manages a refresh token directly (the typed field on `BlocksLogoutRequest`). If your app relies on the hosted IdP's session cookie instead, an empty `{}` is enough — the SDK always sends the request with `credentials: "include"`.
|
|
69
|
-
- **`auth.logoutAll(request = {})`** — "Sign out everywhere" — invalidates every session for the account, not just the current one. Good for a security settings page next to change-password.
|
|
70
|
-
|
|
71
|
-
```ts
|
|
72
|
-
async function signOut() {
|
|
73
|
-
try {
|
|
74
|
-
await blocksClient.auth.logout({ refreshToken });
|
|
75
|
-
} finally {
|
|
76
|
-
// clear app-owned session state even if the network call fails,
|
|
77
|
-
// so the UI never shows a stale signed-in state
|
|
78
|
-
clearLocalSession();
|
|
79
|
-
navigate("/login");
|
|
80
|
-
}
|
|
81
|
-
}
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
## Profile bootstrap and self-edit
|
|
85
|
-
|
|
86
|
-
- **`iam.me()`** — The current IAM user record: roles, permissions, active organization context, resolved from the access token. This is the right call to bootstrap an app's profile/account page or a permission-gated shell after login — don't reconstruct this from token claims yourself.
|
|
87
|
-
- **`iam.updateMe(request)`** — Updates the CURRENT authenticated user's own profile fields (name, etc., per your tenant's IAM contract). The backend resolves the user id from the token — **never** pass another user's id here; that's `iam.users.update(id, request)` in the admin skill, a different call entirely.
|
|
88
|
-
|
|
89
|
-
```ts
|
|
90
|
-
const me = await blocksClient.iam.me();
|
|
91
|
-
// me.data?.roles / me.data?.permissions -> gate nav items, feature flags, etc.
|
|
92
|
-
// (iam.me() wraps the user record in a { data } envelope, not the fields directly)
|
|
93
|
-
|
|
94
|
-
await blocksClient.iam.updateMe({ firstName, lastName });
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
## Self-service MFA
|
|
98
|
-
|
|
99
|
-
Enrolling, challenging, or turning off MFA for the **signed-in user's own** account, via `blocksClient.mfa.*` (see `mfa-client.ts`'s own docstrings — they call this out as self-service, distinct from `mfa.saveConfig`, which is a tenant/admin policy action, not covered here):
|
|
100
|
-
|
|
101
|
-
- **`mfa.totp.setup()`** — Starts authenticator-app enrollment; render IAM's returned secret/QR in your UI.
|
|
102
|
-
- **`mfa.totp.verifySetup({ code })`** — Confirms enrollment with the 6-digit code from the authenticator app.
|
|
103
|
-
- **`mfa.generate({ mfaType, sendPhoneNumberAsEmailDomain? })`** — Sends an email/SMS OTP challenge; returns an `mfaId` for `resend`/`verify`.
|
|
104
|
-
- **`mfa.resend({ mfaId, sendPhoneNumberAsEmailDomain? })`** — Re-sends a pending OTP.
|
|
105
|
-
- **`mfa.verify({ mfaId, verificationCode, authType, isFromTokenCall? })`** — Confirms an OTP or step-up challenge; set `isFromTokenCall` when verifying as part of a login/token exchange.
|
|
106
|
-
- **`mfa.setMethod({ mfaType })`** — Switches which enrolled method is active.
|
|
107
|
-
- **`mfa.disable()`** — Self-service opt-out, where the tenant's policy allows it.
|
|
108
|
-
- **`mfa.backupCodes.list()`** / **`.generate()`** / **`.use({ code, userId })`** — View remaining recovery codes, mint a fresh set (treat the response as sensitive, show once), or consume one when the primary method is unavailable.
|
|
109
|
-
|
|
110
|
-
```ts
|
|
111
|
-
await blocksClient.mfa.totp.setup();
|
|
112
|
-
await blocksClient.mfa.totp.verifySetup({ code });
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
The same self-service surface is also reachable from a terminal via `blocks mfa totp setup/verify-setup/enable`, `blocks mfa generate/resend/verify`, `blocks mfa method set`, `blocks mfa disable`, and `blocks mfa backup-codes list/generate/use` (project-scoped, impersonated-user token). **See also:** `blocks-iam-mfa` for the full enrollment/challenge walkthrough — this section only flags that self-service MFA exists and is in this skill's scope.
|
|
116
|
-
|
|
117
|
-
## Signup and login discovery
|
|
118
|
-
|
|
119
|
-
- **`auth.signup(request)`** — no auth required. Registers a new account; IAM owns account-creation rules — send its expected payload and render its response/errors directly rather than pre-validating fields yourself.
|
|
120
|
-
- **`auth.loginOptions()`** — no auth required. Discovers which login methods the tenant supports; call before rendering the login screen so you only show controls IAM actually accepts.
|
|
121
|
-
|
|
122
|
-
```ts
|
|
123
|
-
const options = await blocksClient.auth.loginOptions();
|
|
124
|
-
// options -> render enabled login methods (password, social, etc.)
|
|
125
|
-
|
|
126
|
-
await blocksClient.auth.signup({ email, password, firstName, lastName });
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
## Signup/invite dedup checks
|
|
130
|
-
|
|
131
|
-
Useful inside a signup or invite form before submit — both still send `x-blocks-key` even though they don't require a signed-in user:
|
|
132
|
-
|
|
133
|
-
- **`iam.users.emailAvailable(query)`** — no auth required. Returns an availability flag (`isAvailable`/`IsAvailable` — IAM's casing varies, check both) for a candidate email.
|
|
134
|
-
- **`iam.users.exists(email)`** — Existence check by email.
|
|
135
|
-
|
|
136
|
-
```ts
|
|
137
|
-
const availability = await blocksClient.iam.users.emailAvailable({ email });
|
|
138
|
-
if (availability.isAvailable === false || availability.IsAvailable === false) {
|
|
139
|
-
// show "email already in use" before the user finishes the form
|
|
140
|
-
}
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
## Gotchas
|
|
144
|
-
|
|
145
|
-
- **Don't invent payload fields.** Several of these methods (`activate`, `resendActivation`, `validateActivation`, `changePassword`, `recover`, `resetPassword`, `logoutAll`, `updateMe`) take an untyped `Record<string, unknown>` in the SDK — the shape is IAM's contract, not something the client library enforces. Use the well-known fields shown above; confirm anything beyond that against the tenant's actual IAM behavior instead of guessing new field names.
|
|
146
|
-
- **`activate`/`validateActivation`/`recover`/`resetPassword` are public (no bearer token)** — the emailed code/token *is* the credential. `changePassword` and `updateMe` require an access token to be configured on the client (via `accessToken` on `createBlocksClient`). `logout`/`logoutAll`/`resendActivation` will attach a bearer token if one is configured, but don't require it.
|
|
147
|
-
- **`iam.me()` is not `auth.userInfo()` or `auth.isAuthenticated()`.** `auth.userInfo()`/`isAuthenticated()` (OIDC-style claims, session-cookie aware) belong to the SSO/OIDC login-flow territory. `iam.me()` is the full IAM user record — roles, permissions, org context — wrapped in a `{ data }` envelope (`BlocksMeResponse = BlocksQueryResponse<BlocksUser>`), so read `me.data?.roles` etc., not `me.roles` directly.
|
|
148
|
-
- **Always clear local app state after logout, even on failure.** The SDK doesn't clear anything for you; a network error from `logout`/`logoutAll` shouldn't leave the UI showing a signed-in user.
|
|
149
|
-
- **`updateMe` never takes a user id.** If you find yourself passing an id, you want the admin `iam.users.update(id, request)` call instead — wrong skill for that.
|
|
150
|
-
- **Confirm-password fields are UI-only.** IAM's `activate`/`resetPassword`/`changePassword` contracts want the new password once; matching against a second "confirm" field is validated client-side and never sent.
|
|
151
|
-
|
|
152
|
-
## Example trigger prompts
|
|
153
|
-
|
|
154
|
-
- "Activate a new account with the emailed code."
|
|
155
|
-
- "Build the /activate page that sets a password from an invite link."
|
|
156
|
-
- "The activation link expired — let the user request a new one."
|
|
157
|
-
- "Add a forgot-password flow to the login page."
|
|
158
|
-
- "Build the reset-password page for the emailed reset link."
|
|
159
|
-
- "Let a signed-in user change their password from account settings."
|
|
160
|
-
- "Add a logout button."
|
|
161
|
-
- "Add a 'sign out of all devices' option."
|
|
162
|
-
- "Fetch the current user's roles and permissions after login."
|
|
163
|
-
- "Let a user edit their own name on their profile page."
|
|
164
|
-
- "Check if an email is already taken before letting someone submit the signup form."
|
|
165
|
-
- "Register a new account from the signup page."
|
|
166
|
-
- "Show which login methods are enabled before rendering the login screen."
|
|
167
|
-
- "Let a signed-in user enroll in authenticator-app MFA."
|
|
168
|
-
- "Add a 'turn off MFA' option to account security settings."
|
|
169
|
-
- "Let a user view or regenerate their MFA backup codes."
|
|
1
|
+
---
|
|
2
|
+
name: blocks-iam-account
|
|
3
|
+
description: "Signed-in (or partially-signed-in) user's own SELISE Blocks IAM account actions via @seliseblocks/client — never raw fetch/curl. Covers activation, forgot/reset/change password, logout(-all), profile bootstrap (iam.me/updateMe), self-service MFA, signup, and login-options discovery. Use for activation/password pages, logout buttons, profile bootstrap, signup forms, or letting a user manage their own MFA. The self-service half of IAM — not admin CRUD on other users (blocks-iam-users/blocks-iam-access-control), not hosted-login redirect (blocks-iam-sso-oidc-implementation)."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Blocks IAM — Account Self-Service
|
|
7
|
+
|
|
8
|
+
Account-lifecycle and account-security actions the signed-in (or not-yet-fully-signed-in) user takes on **their own** account, all through the single `@seliseblocks/client` instance the scaffold gives you — `blocks new web` wires up `createBlocksClient({ apiUrl, xBlocksKey, oidc, accessToken })` once; every call below hangs off that instance's `.auth`, `.iam`, or `.mfa` namespace. **Never** hand-roll `fetch`/`curl` against `api.seliseblocks.com` for these.
|
|
9
|
+
|
|
10
|
+
Source of truth: `auth-client.ts`, `iam-client.ts`, and `mfa-client.ts` in `@seliseblocks/client`. Every method has a What/Why/How docstring in source — this skill surfaces them, it doesn't add new ones.
|
|
11
|
+
|
|
12
|
+
## Scope: this vs. the other IAM skills
|
|
13
|
+
|
|
14
|
+
- **This skill** — the current user acting on themselves: activate their own invite, reset their own forgotten password, change their own password, log themselves out, read/edit their own profile, sign up, discover login options, enroll/manage their own MFA.
|
|
15
|
+
- **blocks-iam-users / blocks-iam-access-control** — an admin managing *other* users (create, deactivate, grant/revoke access). Different actor, different skill. Don't duplicate that here.
|
|
16
|
+
- **blocks-iam-sso-oidc-implementation** — the hosted-login redirect/callback flow (`auth.idp.initiate`/`redirectToProvider`/`callback`, `oidc.refreshToken`). This skill only covers direct account-lifecycle calls (activate, recover, reset, change-password, logout) that a user takes outside that redirect dance — don't reimplement hosted login here.
|
|
17
|
+
- **blocks-iam-mfa** (not yet written) — the full self-service MFA walkthrough (enrollment UX, challenge flows, backup codes). This skill only notes that `mfa.*` exists and is in scope; go there for depth.
|
|
18
|
+
|
|
19
|
+
## The SDK never owns your session
|
|
20
|
+
|
|
21
|
+
Every method here just relays IAM's request/response. The SDK **does not** read or write cookies, localStorage, or any token store — your app decides where the access token, refresh token, and "am I logged in" flag live, and passes the access token in via the `accessToken` option (string or async callback) on `createBlocksClient`. After `logout`/`logoutAll`, activation, or a password reset, **you** clear/update that app-owned state; the SDK call alone doesn't do it for you.
|
|
22
|
+
|
|
23
|
+
Request/payload types for most of these methods are intentionally loose (`Record<string, unknown>` passthrough — IAM, not the SDK, defines the exact fields). `BlocksLogoutRequest` is the one exception with a typed hint (`refreshToken?: string`). Where the SDK doesn't pin the shape, confirm exact field names against your tenant's IAM contract rather than guessing — the examples below show the well-known fields, not an exhaustive schema.
|
|
24
|
+
|
|
25
|
+
## Activation — finishing account setup
|
|
26
|
+
|
|
27
|
+
Three related calls, all under `blocksClient.auth`, all public (no bearer token needed for `activate`/`validateActivation` — the emailed code is the credential):
|
|
28
|
+
|
|
29
|
+
- **`auth.validateActivation(request)`** — no auth required. Check the activation code/state *before* showing the final "set your password" step, so an expired/invalid link fails fast with a clear message instead of after the user fills out the form.
|
|
30
|
+
- **`auth.activate(request)`** — no auth required. Completes setup for a user created/invited in an inactive state: pass the emailed `code` plus the new password (and whatever else your tenant's activation contract needs, e.g. `firstName`/`lastName`) after your UI confirms password === confirm-password client-side (don't send a confirm field — that's a UI-only check).
|
|
31
|
+
- **`auth.resendActivation(request)`** — Send a new code/link when the old one expired. This call attaches the bearer token if one happens to be configured, but works either way — typical callers are not-yet-active, so don't gate this behind requiring a token.
|
|
32
|
+
|
|
33
|
+
```ts
|
|
34
|
+
// after the user opens /activate?code=... and submits password + confirm
|
|
35
|
+
const state = await blocksClient.auth.validateActivation({ code });
|
|
36
|
+
if (!state.valid) {
|
|
37
|
+
// show "this link expired" + a resend option
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
await blocksClient.auth.activate({
|
|
41
|
+
code,
|
|
42
|
+
password,
|
|
43
|
+
firstName,
|
|
44
|
+
lastName
|
|
45
|
+
});
|
|
46
|
+
// account is now active — route to login / hosted-login (blocks-iam-sso-oidc-implementation)
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Password — forgot, reset, and authenticated change
|
|
50
|
+
|
|
51
|
+
- **`auth.recover(request)`** — no auth required. Public entry point for "forgot password" — typically just the account's email. Triggers IAM to send a reset link/code.
|
|
52
|
+
- **`auth.resetPassword(request)`** — no auth required. Completes the recovery: pass the emailed reset token plus the new password. IAM owns token validation and password-policy enforcement — surface its response/errors directly rather than pre-validating password rules yourself.
|
|
53
|
+
- **`auth.changePassword(request)`** — requires an access token (an authenticated account-security action, not part of the recovery flow). Use this for a signed-in "change my password" settings-page action — current password + new password.
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
// forgot-password page
|
|
57
|
+
await blocksClient.auth.recover({ email });
|
|
58
|
+
|
|
59
|
+
// reset-password page (link from the recovery email)
|
|
60
|
+
await blocksClient.auth.resetPassword({ code, password: newPassword });
|
|
61
|
+
|
|
62
|
+
// signed-in settings page
|
|
63
|
+
await blocksClient.auth.changePassword({ oldPassword, newPassword });
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Logout — end this session or all sessions
|
|
67
|
+
|
|
68
|
+
- **`auth.logout(request = {})`** — Ends the current session; commonly takes `{ refreshToken }` if your app manages a refresh token directly (the typed field on `BlocksLogoutRequest`). If your app relies on the hosted IdP's session cookie instead, an empty `{}` is enough — the SDK always sends the request with `credentials: "include"`.
|
|
69
|
+
- **`auth.logoutAll(request = {})`** — "Sign out everywhere" — invalidates every session for the account, not just the current one. Good for a security settings page next to change-password.
|
|
70
|
+
|
|
71
|
+
```ts
|
|
72
|
+
async function signOut() {
|
|
73
|
+
try {
|
|
74
|
+
await blocksClient.auth.logout({ refreshToken });
|
|
75
|
+
} finally {
|
|
76
|
+
// clear app-owned session state even if the network call fails,
|
|
77
|
+
// so the UI never shows a stale signed-in state
|
|
78
|
+
clearLocalSession();
|
|
79
|
+
navigate("/login");
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Profile bootstrap and self-edit
|
|
85
|
+
|
|
86
|
+
- **`iam.me()`** — The current IAM user record: roles, permissions, active organization context, resolved from the access token. This is the right call to bootstrap an app's profile/account page or a permission-gated shell after login — don't reconstruct this from token claims yourself.
|
|
87
|
+
- **`iam.updateMe(request)`** — Updates the CURRENT authenticated user's own profile fields (name, etc., per your tenant's IAM contract). The backend resolves the user id from the token — **never** pass another user's id here; that's `iam.users.update(id, request)` in the admin skill, a different call entirely.
|
|
88
|
+
|
|
89
|
+
```ts
|
|
90
|
+
const me = await blocksClient.iam.me();
|
|
91
|
+
// me.data?.roles / me.data?.permissions -> gate nav items, feature flags, etc.
|
|
92
|
+
// (iam.me() wraps the user record in a { data } envelope, not the fields directly)
|
|
93
|
+
|
|
94
|
+
await blocksClient.iam.updateMe({ firstName, lastName });
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Self-service MFA
|
|
98
|
+
|
|
99
|
+
Enrolling, challenging, or turning off MFA for the **signed-in user's own** account, via `blocksClient.mfa.*` (see `mfa-client.ts`'s own docstrings — they call this out as self-service, distinct from `mfa.saveConfig`, which is a tenant/admin policy action, not covered here):
|
|
100
|
+
|
|
101
|
+
- **`mfa.totp.setup()`** — Starts authenticator-app enrollment; render IAM's returned secret/QR in your UI.
|
|
102
|
+
- **`mfa.totp.verifySetup({ code })`** — Confirms enrollment with the 6-digit code from the authenticator app.
|
|
103
|
+
- **`mfa.generate({ mfaType, sendPhoneNumberAsEmailDomain? })`** — Sends an email/SMS OTP challenge; returns an `mfaId` for `resend`/`verify`.
|
|
104
|
+
- **`mfa.resend({ mfaId, sendPhoneNumberAsEmailDomain? })`** — Re-sends a pending OTP.
|
|
105
|
+
- **`mfa.verify({ mfaId, verificationCode, authType, isFromTokenCall? })`** — Confirms an OTP or step-up challenge; set `isFromTokenCall` when verifying as part of a login/token exchange.
|
|
106
|
+
- **`mfa.setMethod({ mfaType })`** — Switches which enrolled method is active.
|
|
107
|
+
- **`mfa.disable()`** — Self-service opt-out, where the tenant's policy allows it.
|
|
108
|
+
- **`mfa.backupCodes.list()`** / **`.generate()`** / **`.use({ code, userId })`** — View remaining recovery codes, mint a fresh set (treat the response as sensitive, show once), or consume one when the primary method is unavailable.
|
|
109
|
+
|
|
110
|
+
```ts
|
|
111
|
+
await blocksClient.mfa.totp.setup();
|
|
112
|
+
await blocksClient.mfa.totp.verifySetup({ code });
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
The same self-service surface is also reachable from a terminal via `blocks mfa totp setup/verify-setup/enable`, `blocks mfa generate/resend/verify`, `blocks mfa method set`, `blocks mfa disable`, and `blocks mfa backup-codes list/generate/use` (project-scoped, impersonated-user token). **See also:** `blocks-iam-mfa` for the full enrollment/challenge walkthrough — this section only flags that self-service MFA exists and is in this skill's scope.
|
|
116
|
+
|
|
117
|
+
## Signup and login discovery
|
|
118
|
+
|
|
119
|
+
- **`auth.signup(request)`** — no auth required. Registers a new account; IAM owns account-creation rules — send its expected payload and render its response/errors directly rather than pre-validating fields yourself.
|
|
120
|
+
- **`auth.loginOptions()`** — no auth required. Discovers which login methods the tenant supports; call before rendering the login screen so you only show controls IAM actually accepts.
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
const options = await blocksClient.auth.loginOptions();
|
|
124
|
+
// options -> render enabled login methods (password, social, etc.)
|
|
125
|
+
|
|
126
|
+
await blocksClient.auth.signup({ email, password, firstName, lastName });
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Signup/invite dedup checks
|
|
130
|
+
|
|
131
|
+
Useful inside a signup or invite form before submit — both still send `x-blocks-key` even though they don't require a signed-in user:
|
|
132
|
+
|
|
133
|
+
- **`iam.users.emailAvailable(query)`** — no auth required. Returns an availability flag (`isAvailable`/`IsAvailable` — IAM's casing varies, check both) for a candidate email.
|
|
134
|
+
- **`iam.users.exists(email)`** — Existence check by email.
|
|
135
|
+
|
|
136
|
+
```ts
|
|
137
|
+
const availability = await blocksClient.iam.users.emailAvailable({ email });
|
|
138
|
+
if (availability.isAvailable === false || availability.IsAvailable === false) {
|
|
139
|
+
// show "email already in use" before the user finishes the form
|
|
140
|
+
}
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Gotchas
|
|
144
|
+
|
|
145
|
+
- **Don't invent payload fields.** Several of these methods (`activate`, `resendActivation`, `validateActivation`, `changePassword`, `recover`, `resetPassword`, `logoutAll`, `updateMe`) take an untyped `Record<string, unknown>` in the SDK — the shape is IAM's contract, not something the client library enforces. Use the well-known fields shown above; confirm anything beyond that against the tenant's actual IAM behavior instead of guessing new field names.
|
|
146
|
+
- **`activate`/`validateActivation`/`recover`/`resetPassword` are public (no bearer token)** — the emailed code/token *is* the credential. `changePassword` and `updateMe` require an access token to be configured on the client (via `accessToken` on `createBlocksClient`). `logout`/`logoutAll`/`resendActivation` will attach a bearer token if one is configured, but don't require it.
|
|
147
|
+
- **`iam.me()` is not `auth.userInfo()` or `auth.isAuthenticated()`.** `auth.userInfo()`/`isAuthenticated()` (OIDC-style claims, session-cookie aware) belong to the SSO/OIDC login-flow territory. `iam.me()` is the full IAM user record — roles, permissions, org context — wrapped in a `{ data }` envelope (`BlocksMeResponse = BlocksQueryResponse<BlocksUser>`), so read `me.data?.roles` etc., not `me.roles` directly.
|
|
148
|
+
- **Always clear local app state after logout, even on failure.** The SDK doesn't clear anything for you; a network error from `logout`/`logoutAll` shouldn't leave the UI showing a signed-in user.
|
|
149
|
+
- **`updateMe` never takes a user id.** If you find yourself passing an id, you want the admin `iam.users.update(id, request)` call instead — wrong skill for that.
|
|
150
|
+
- **Confirm-password fields are UI-only.** IAM's `activate`/`resetPassword`/`changePassword` contracts want the new password once; matching against a second "confirm" field is validated client-side and never sent.
|
|
151
|
+
|
|
152
|
+
## Example trigger prompts
|
|
153
|
+
|
|
154
|
+
- "Activate a new account with the emailed code."
|
|
155
|
+
- "Build the /activate page that sets a password from an invite link."
|
|
156
|
+
- "The activation link expired — let the user request a new one."
|
|
157
|
+
- "Add a forgot-password flow to the login page."
|
|
158
|
+
- "Build the reset-password page for the emailed reset link."
|
|
159
|
+
- "Let a signed-in user change their password from account settings."
|
|
160
|
+
- "Add a logout button."
|
|
161
|
+
- "Add a 'sign out of all devices' option."
|
|
162
|
+
- "Fetch the current user's roles and permissions after login."
|
|
163
|
+
- "Let a user edit their own name on their profile page."
|
|
164
|
+
- "Check if an email is already taken before letting someone submit the signup form."
|
|
165
|
+
- "Register a new account from the signup page."
|
|
166
|
+
- "Show which login methods are enabled before rendering the login screen."
|
|
167
|
+
- "Let a signed-in user enroll in authenticator-app MFA."
|
|
168
|
+
- "Add a 'turn off MFA' option to account security settings."
|
|
169
|
+
- "Let a user view or regenerate their MFA backup codes."
|