@seliseblocks/cli-os 0.2.3 → 0.2.5
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 +560 -560
- package/LICENSE +21 -21
- package/README.md +173 -173
- package/bin/run.js +2 -2
- package/dist/commands/auth/idp/create.d.ts +7 -0
- package/dist/commands/auth/idp/create.js +22 -3
- package/dist/commands/auth/idp/update.d.ts +7 -0
- package/dist/commands/auth/idp/update.js +22 -3
- package/dist/commands/new/web.js +4 -0
- package/dist/index.js +692 -672
- package/dist/lib/scaffold-web/app-core.js +6 -1
- package/dist/lib/scaffold-web/blocks-lib.js +36 -2
- 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 -253
- package/dist/skills/blocks-data-storage/flows/object-management.md +124 -124
- package/dist/skills/blocks-frontend-local-https/SKILL.md +100 -100
- package/dist/skills/blocks-iam-access-control/SKILL.md +49 -49
- package/dist/skills/blocks-iam-access-control/flows/feature-gating.md +38 -38
- package/dist/skills/blocks-iam-access-control/flows/manage-roles-permissions.md +110 -110
- package/dist/skills/blocks-iam-account/SKILL.md +169 -169
- package/dist/skills/blocks-iam-mfa/SKILL.md +124 -124
- package/dist/skills/blocks-iam-organizations/SKILL.md +43 -43
- package/dist/skills/blocks-iam-organizations/flows/admin-mutations.md +89 -89
- package/dist/skills/blocks-iam-organizations/flows/read-and-switch.md +57 -57
- package/dist/skills/blocks-iam-sso-oidc-configuration/SKILL.md +105 -89
- 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-mail/SKILL.md +95 -95
- package/dist/skills/blocks-notification/SKILL.md +69 -69
- package/dist/skills/blocks-notifier/SKILL.md +107 -107
- package/dist/skills/blocks-onboarding/SKILL.md +78 -78
- package/dist/skills/blocks-release-deployment/SKILL.md +81 -81
- package/dist/skills/blocks-secrets/SKILL.md +81 -81
- package/dist/skills/blocks-storage-configuration/SKILL.md +93 -93
- package/dist/skills/lint.mjs +168 -168
- package/package.json +47 -47
|
@@ -1,124 +1,124 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: blocks-iam-mfa
|
|
3
|
-
description: "Self-service MFA for the signed-in user's own account — TOTP enroll/verify, OTP generate/resend/verify, method switch, disable, backup codes — via `blocksClient.mfa.*` or the project-scoped `blocks mfa *` CLI, plus tenant-wide MFA policy admin (`mfa.saveConfig` / `blocks mfa config get/save`). Use for an MFA settings screen, scripted enrollment/checks, or reading/setting a tenant's MFA policy. Not for admin-forcing MFA onto another specific user."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Blocks IAM — MFA (Multi-Factor Authentication)
|
|
7
|
-
|
|
8
|
-
Two different things live under "MFA," and this skill covers both without conflating them:
|
|
9
|
-
|
|
10
|
-
1. **Self-service enrollment/verification** — the signed-in user setting up, challenging, switching, or removing MFA on **their own** account. This is `blocksClient.mfa.*` (minus `saveConfig`) in an app, or `blocks mfa totp *` / `mfa generate` / `mfa resend` / `mfa verify` / `mfa method set` / `mfa disable` / `mfa backup-codes *` from a terminal.
|
|
11
|
-
2. **Tenant-wide MFA policy admin** — whether MFA is enabled/required for the tenant at all, which methods are allowed, backup-code settings, and which roles are required/exempt. This is `blocksClient.mfa.config()` / `mfa.saveConfig(request)`, or `blocks mfa config get` / `mfa config save`. It configures the tenant's rules, not any one user's enrollment state.
|
|
12
|
-
|
|
13
|
-
Source of truth: the `@seliseblocks/client` SDK's `mfa` namespace and the `blocks mfa *` CLI command family — this skill surfaces their documented behavior, it doesn't add new capability.
|
|
14
|
-
|
|
15
|
-
## Scope: this vs. the other IAM skills
|
|
16
|
-
|
|
17
|
-
- **This skill** — the signed-in user's own MFA enrollment/verification, and tenant-wide MFA policy configuration (`config`/`saveConfig`).
|
|
18
|
-
- **blocks-iam-account** — the rest of the signed-in user's own account lifecycle (activation, forgot/reset/change password, logout, profile bootstrap, signup). It links here for MFA depth; don't duplicate that material in this file.
|
|
19
|
-
- **blocks-iam-users** — an admin managing *other* users' IAM records (create, deactivate, grant/revoke access). Nothing in the SDK's `mfa` namespace or the CLI's `mfa` command family lets an admin force-enroll, reset, or disable MFA on a specific *other* user's account — the closest thing is tenant-wide, role-based policy (`mfaRequiredRoles`/`mfaExemptRoles` in `saveConfig`), which applies to a role, not a targeted user id. If a caller wants to act on another named user's MFA specifically, that capability wasn't found in this source; don't invent an endpoint for it.
|
|
20
|
-
|
|
21
|
-
## SDK — `blocksClient.mfa.*`
|
|
22
|
-
|
|
23
|
-
| Method | What |
|
|
24
|
-
|---|---|
|
|
25
|
-
| `mfa.config()` | Reads the tenant's current MFA policy. Tenant-wide, not per-user. |
|
|
26
|
-
| `mfa.saveConfig(request)` | Saves the tenant's MFA policy (enable/require MFA, allowed methods, backup-code settings, required/exempt roles). Admin/tenant-settings action — IAM enforces the required role, the SDK does not gate it. |
|
|
27
|
-
| `mfa.totp.setup()` | Starts authenticator-app enrollment for the signed-in user; render IAM's returned secret/QR payload in your UI. |
|
|
28
|
-
| `mfa.totp.verifySetup({ code })` | Confirms enrollment with the 6-digit code from the authenticator app. |
|
|
29
|
-
| `mfa.generate({ mfaType, sendPhoneNumberAsEmailDomain? })` | Sends an email/SMS OTP challenge; IAM returns an `mfaId` to pass to `resend`/`verify`. |
|
|
30
|
-
| `mfa.resend({ mfaId, sendPhoneNumberAsEmailDomain? })` | Re-sends a pending OTP (e.g. SMS delay, spam filtering). |
|
|
31
|
-
| `mfa.verify({ mfaId, verificationCode, authType, isFromTokenCall? })` | Confirms an OTP or step-up challenge; set `isFromTokenCall` when verifying as part of a login/token exchange rather than a standalone check. |
|
|
32
|
-
| `mfa.setMethod({ mfaType })` | Switches which enrolled method is active for a user with more than one enrolled. |
|
|
33
|
-
| `mfa.disable()` | Self-service opt-out for the signed-in user, where the tenant's policy allows it. |
|
|
34
|
-
| `mfa.backupCodes.list()` | Lists the signed-in user's backup codes (e.g. remaining-count display). |
|
|
35
|
-
| `mfa.backupCodes.generate()` | Mints a fresh set of recovery codes. Treat the response as sensitive and show it to the user only once. |
|
|
36
|
-
| `mfa.backupCodes.use({ code, userId })` | Consumes one backup code to complete login/step-up when the primary method is unavailable. `userId` is the signed-in user's own id, not a target for an admin acting on someone else. |
|
|
37
|
-
|
|
38
|
-
```ts
|
|
39
|
-
// enrollment
|
|
40
|
-
await blocksClient.mfa.totp.setup(); // render the returned secret/QR
|
|
41
|
-
await blocksClient.mfa.totp.verifySetup({ code });
|
|
42
|
-
|
|
43
|
-
// OTP challenge (email/SMS-based methods)
|
|
44
|
-
const { mfaId } = await blocksClient.mfa.generate({ mfaType });
|
|
45
|
-
await blocksClient.mfa.verify({ mfaId, verificationCode, authType });
|
|
46
|
-
|
|
47
|
-
// tenant policy (admin screen only)
|
|
48
|
-
const policy = await blocksClient.mfa.config();
|
|
49
|
-
await blocksClient.mfa.saveConfig({ enableMfa: true, requireMfaForAllUsers: false });
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
`mfaType` and `authType` are plain numbers defined by IAM's own contract, treated as opaque by both the SDK and CLI — their enum names aren't published anywhere. Neither documents what integer means "TOTP" vs. "SMS" vs. "email" for a given tenant; confirm the value against the tenant's actual IAM config (`mfa.config()` / `blocks mfa config get`) rather than guessing one.
|
|
53
|
-
|
|
54
|
-
## CLI — `blocks mfa *`
|
|
55
|
-
|
|
56
|
-
Every `mfa` command is **project-scoped**: it requires a project already selected (`blocks use <tenantId>`) and calls IAM with an impersonated project token — never the account token. Command segments joined by a space also accept a colon form (`mfa:totp:setup`, `mfa:backup-codes:generate`, etc.) — both resolve to the same command.
|
|
57
|
-
|
|
58
|
-
Tenant policy admin (reads/mutates the tenant's rules, not a user's enrollment):
|
|
59
|
-
|
|
60
|
-
| Command | What |
|
|
61
|
-
|---|---|
|
|
62
|
-
| `blocks mfa config get [--json]` | Reads the tenant's MFA policy. |
|
|
63
|
-
| `blocks mfa config save [--enable] [--require-for-all-users] [--allow-user-opt-out] [--allow-backup-codes] [--backup-codes-count <n>] [--user-mfa-type 0,1] [--required-roles a,b] [--exempt-roles a,b] [--body '<json>'\|--file <path>] [--dry-run] [--yes] [--json]` | Saves the tenant's MFA policy. `--body`/`--file` supplies a base JSON payload; any convenience flag also passed overwrites the matching key on top of it. Requires `--dry-run` (preview only) or `--yes`/an interactive `yes` before it executes. |
|
|
64
|
-
|
|
65
|
-
Self-service enrollment, challenge, and recovery for the calling (impersonated) user:
|
|
66
|
-
|
|
67
|
-
| Command | What |
|
|
68
|
-
|---|---|
|
|
69
|
-
| `blocks mfa totp setup [--json]` | Starts TOTP enrollment; prints IAM's secret/QR payload. |
|
|
70
|
-
| `blocks mfa totp verify-setup <code> [--json]` | Confirms TOTP enrollment with the 6-digit code. |
|
|
71
|
-
| `blocks mfa totp enable --mfa-type <n> [--code <c>] [--dry-run] [--yes] [--json]` | Composed enrollment — see below. |
|
|
72
|
-
| `blocks mfa generate --mfa-type <n> [--send-phone-number-as-email-domain <domain>] [--json]` | Sends an OTP challenge; returns an `mfaId` to pass to `resend`/`verify`. |
|
|
73
|
-
| `blocks mfa resend <mfaId> [--send-phone-number-as-email-domain <domain>] [--json]` | Re-sends a pending OTP. |
|
|
74
|
-
| `blocks mfa verify <mfaId> <code> --auth-type <n> [--from-token-call] [--json]` | Confirms an OTP/step-up challenge. |
|
|
75
|
-
| `blocks mfa method set --mfa-type <n> [--json]` | Switches the impersonated user's active MFA method. |
|
|
76
|
-
| `blocks mfa disable [--dry-run] [--yes] [--json]` | Disables MFA for the impersonated user. Mutating: needs `--dry-run` or `--yes`. |
|
|
77
|
-
| `blocks mfa backup-codes list [--json]` | Lists the impersonated user's backup codes. Read-only. |
|
|
78
|
-
| `blocks mfa backup-codes generate [--dry-run] [--yes] [--json]` | Generates a fresh set, invalidating existing ones. Mutating: needs `--dry-run` or `--yes`. |
|
|
79
|
-
| `blocks mfa backup-codes use <userId> <code> [--json]` | Consumes one backup code. |
|
|
80
|
-
|
|
81
|
-
```sh
|
|
82
|
-
blocks mfa config get --json # check tenant policy before prompting enrollment
|
|
83
|
-
blocks mfa totp setup # prints secret/QR
|
|
84
|
-
blocks mfa totp verify-setup 123456
|
|
85
|
-
blocks mfa method set --mfa-type 0
|
|
86
|
-
blocks mfa backup-codes generate --dry-run # preview, no call
|
|
87
|
-
blocks mfa backup-codes generate --yes # after explicit confirmation
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
## The composed `mfa totp enable` command
|
|
91
|
-
|
|
92
|
-
`mfa totp enable --mfa-type <n>` chains the individual TOTP steps into one enrollment sitting, with one confirmation, rather than four separate commands run at different times:
|
|
93
|
-
|
|
94
|
-
`totp setup` → prints the QR/secret → **verification code** (from `--code`, or an interactive prompt if omitted) → `totp verify-setup <code>` → `method set --mfa-type <n>` → `backup-codes generate --yes`.
|
|
95
|
-
|
|
96
|
-
Two things worth calling out precisely, both confirmed against source:
|
|
97
|
-
|
|
98
|
-
- **`--mfa-type` is required, never defaulted.** The numeric value that means "TOTP" for a given tenant isn't documented anywhere in this CLI or SDK (the same opaque-integer caveat as `mfa generate`/`method set` above) — the command throws rather than guessing one. Look it up (e.g. via `mfa config get`, or ask the user) instead of assuming a value like `0`.
|
|
99
|
-
- **Two separate prompts can block a non-interactive run**, not just one: the command asks the operator to type `yes` before it starts (skipped by `--yes`, same as `--dry-run`), and then, independently, if `--code` isn't passed, it prompts for the verification code from stdin with no timeout — in a non-interactive/agent context with no TTY to answer it, this hangs indefinitely rather than failing fast. An agent or script running this command must pass **both** `--yes` and `--code <c>` (the code sourced from wherever the authenticator output is captured) to avoid a hang.
|
|
100
|
-
- `--dry-run` short-circuits before either prompt and before any network call: it prints the planned step list (`mfa:totp:setup`, the scan/enter-code step, `mfa:totp:verify-setup <code>`, `mfa:method:set <n>`, `mfa:backup-codes:generate`) and exits.
|
|
101
|
-
|
|
102
|
-
Deliberately excluded from this composed command: `mfa config save`. That's the separate tenant-wide policy action covered above, not part of enrolling one user.
|
|
103
|
-
|
|
104
|
-
## Gotchas
|
|
105
|
-
|
|
106
|
-
- **`config`/`saveConfig` (SDK) and `mfa config get`/`config save` (CLI) are tenant policy, not a user's enrollment state.** Don't call these expecting to see or change one user's MFA status — that's every other method/command in this file.
|
|
107
|
-
- **`mfaType`/`authType` are opaque, tenant-defined integers.** Neither the SDK's types nor the CLI documents what number means "TOTP," "SMS," or "email" — confirm against the tenant's own IAM config rather than guessing.
|
|
108
|
-
- **`mfa totp enable` can hang waiting on stdin twice over** if run non-interactively without `--yes` and `--code` — see above. Always pass both when scripting or agent-driving this command.
|
|
109
|
-
- **Backup codes are shown once.** Treat `backupCodes.generate()` / `mfa backup-codes generate`'s response as sensitive; there's no re-display endpoint for the raw codes, only `list()`/`backup-codes list`, which is for a remaining-count style view, not for recovering codes you didn't save.
|
|
110
|
-
- **No admin "force MFA on this specific user" capability was found in this source.** The nearest thing is tenant-wide, role-based policy (`mfaRequiredRoles`/`mfaExemptRoles` via `saveConfig`/`config save`), which targets a role, not a user id. If a request needs a specific other user's MFA changed, that's out of this skill's scope — don't fabricate an endpoint to satisfy it.
|
|
111
|
-
- **Every `mfa` CLI command is project-scoped and impersonation-only**, same rule as the rest of the project-scoped CLI surface — `blocks use <tenantId>` first, or commands fail with `project_not_selected`.
|
|
112
|
-
- **Mutating CLI commands (`config save`, `disable`, `backup-codes generate`, and the composed `totp enable`) require `--dry-run` or `--yes`/an interactive `yes`** before they execute — apply the same confirm-before-mutating discipline an agent uses for any other mutating Blocks CLI command: state the exact change and get explicit go-ahead first.
|
|
113
|
-
|
|
114
|
-
## Example trigger prompts
|
|
115
|
-
|
|
116
|
-
- "Let a signed-in user enroll in authenticator-app (TOTP) MFA."
|
|
117
|
-
- "Build the MFA settings screen: enroll, switch method, disable, view backup codes."
|
|
118
|
-
- "Check whether this tenant requires MFA before showing the enrollment prompt."
|
|
119
|
-
- "Turn on MFA for the whole tenant and require it for the admin role."
|
|
120
|
-
- "Send an OTP code to the user and verify what they typed."
|
|
121
|
-
- "Let a user regenerate their MFA backup codes."
|
|
122
|
-
- "From the terminal, enroll the current project's impersonated user in TOTP MFA end to end."
|
|
123
|
-
- "Run TOTP enrollment non-interactively from a script" → pass both `--yes` and `--code <c>` to `blocks mfa totp enable`, never run it unattended without them.
|
|
124
|
-
- "Read the tenant's current MFA policy from the CLI."
|
|
1
|
+
---
|
|
2
|
+
name: blocks-iam-mfa
|
|
3
|
+
description: "Self-service MFA for the signed-in user's own account — TOTP enroll/verify, OTP generate/resend/verify, method switch, disable, backup codes — via `blocksClient.mfa.*` or the project-scoped `blocks mfa *` CLI, plus tenant-wide MFA policy admin (`mfa.saveConfig` / `blocks mfa config get/save`). Use for an MFA settings screen, scripted enrollment/checks, or reading/setting a tenant's MFA policy. Not for admin-forcing MFA onto another specific user."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Blocks IAM — MFA (Multi-Factor Authentication)
|
|
7
|
+
|
|
8
|
+
Two different things live under "MFA," and this skill covers both without conflating them:
|
|
9
|
+
|
|
10
|
+
1. **Self-service enrollment/verification** — the signed-in user setting up, challenging, switching, or removing MFA on **their own** account. This is `blocksClient.mfa.*` (minus `saveConfig`) in an app, or `blocks mfa totp *` / `mfa generate` / `mfa resend` / `mfa verify` / `mfa method set` / `mfa disable` / `mfa backup-codes *` from a terminal.
|
|
11
|
+
2. **Tenant-wide MFA policy admin** — whether MFA is enabled/required for the tenant at all, which methods are allowed, backup-code settings, and which roles are required/exempt. This is `blocksClient.mfa.config()` / `mfa.saveConfig(request)`, or `blocks mfa config get` / `mfa config save`. It configures the tenant's rules, not any one user's enrollment state.
|
|
12
|
+
|
|
13
|
+
Source of truth: the `@seliseblocks/client` SDK's `mfa` namespace and the `blocks mfa *` CLI command family — this skill surfaces their documented behavior, it doesn't add new capability.
|
|
14
|
+
|
|
15
|
+
## Scope: this vs. the other IAM skills
|
|
16
|
+
|
|
17
|
+
- **This skill** — the signed-in user's own MFA enrollment/verification, and tenant-wide MFA policy configuration (`config`/`saveConfig`).
|
|
18
|
+
- **blocks-iam-account** — the rest of the signed-in user's own account lifecycle (activation, forgot/reset/change password, logout, profile bootstrap, signup). It links here for MFA depth; don't duplicate that material in this file.
|
|
19
|
+
- **blocks-iam-users** — an admin managing *other* users' IAM records (create, deactivate, grant/revoke access). Nothing in the SDK's `mfa` namespace or the CLI's `mfa` command family lets an admin force-enroll, reset, or disable MFA on a specific *other* user's account — the closest thing is tenant-wide, role-based policy (`mfaRequiredRoles`/`mfaExemptRoles` in `saveConfig`), which applies to a role, not a targeted user id. If a caller wants to act on another named user's MFA specifically, that capability wasn't found in this source; don't invent an endpoint for it.
|
|
20
|
+
|
|
21
|
+
## SDK — `blocksClient.mfa.*`
|
|
22
|
+
|
|
23
|
+
| Method | What |
|
|
24
|
+
|---|---|
|
|
25
|
+
| `mfa.config()` | Reads the tenant's current MFA policy. Tenant-wide, not per-user. |
|
|
26
|
+
| `mfa.saveConfig(request)` | Saves the tenant's MFA policy (enable/require MFA, allowed methods, backup-code settings, required/exempt roles). Admin/tenant-settings action — IAM enforces the required role, the SDK does not gate it. |
|
|
27
|
+
| `mfa.totp.setup()` | Starts authenticator-app enrollment for the signed-in user; render IAM's returned secret/QR payload in your UI. |
|
|
28
|
+
| `mfa.totp.verifySetup({ code })` | Confirms enrollment with the 6-digit code from the authenticator app. |
|
|
29
|
+
| `mfa.generate({ mfaType, sendPhoneNumberAsEmailDomain? })` | Sends an email/SMS OTP challenge; IAM returns an `mfaId` to pass to `resend`/`verify`. |
|
|
30
|
+
| `mfa.resend({ mfaId, sendPhoneNumberAsEmailDomain? })` | Re-sends a pending OTP (e.g. SMS delay, spam filtering). |
|
|
31
|
+
| `mfa.verify({ mfaId, verificationCode, authType, isFromTokenCall? })` | Confirms an OTP or step-up challenge; set `isFromTokenCall` when verifying as part of a login/token exchange rather than a standalone check. |
|
|
32
|
+
| `mfa.setMethod({ mfaType })` | Switches which enrolled method is active for a user with more than one enrolled. |
|
|
33
|
+
| `mfa.disable()` | Self-service opt-out for the signed-in user, where the tenant's policy allows it. |
|
|
34
|
+
| `mfa.backupCodes.list()` | Lists the signed-in user's backup codes (e.g. remaining-count display). |
|
|
35
|
+
| `mfa.backupCodes.generate()` | Mints a fresh set of recovery codes. Treat the response as sensitive and show it to the user only once. |
|
|
36
|
+
| `mfa.backupCodes.use({ code, userId })` | Consumes one backup code to complete login/step-up when the primary method is unavailable. `userId` is the signed-in user's own id, not a target for an admin acting on someone else. |
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
// enrollment
|
|
40
|
+
await blocksClient.mfa.totp.setup(); // render the returned secret/QR
|
|
41
|
+
await blocksClient.mfa.totp.verifySetup({ code });
|
|
42
|
+
|
|
43
|
+
// OTP challenge (email/SMS-based methods)
|
|
44
|
+
const { mfaId } = await blocksClient.mfa.generate({ mfaType });
|
|
45
|
+
await blocksClient.mfa.verify({ mfaId, verificationCode, authType });
|
|
46
|
+
|
|
47
|
+
// tenant policy (admin screen only)
|
|
48
|
+
const policy = await blocksClient.mfa.config();
|
|
49
|
+
await blocksClient.mfa.saveConfig({ enableMfa: true, requireMfaForAllUsers: false });
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
`mfaType` and `authType` are plain numbers defined by IAM's own contract, treated as opaque by both the SDK and CLI — their enum names aren't published anywhere. Neither documents what integer means "TOTP" vs. "SMS" vs. "email" for a given tenant; confirm the value against the tenant's actual IAM config (`mfa.config()` / `blocks mfa config get`) rather than guessing one.
|
|
53
|
+
|
|
54
|
+
## CLI — `blocks mfa *`
|
|
55
|
+
|
|
56
|
+
Every `mfa` command is **project-scoped**: it requires a project already selected (`blocks use <tenantId>`) and calls IAM with an impersonated project token — never the account token. Command segments joined by a space also accept a colon form (`mfa:totp:setup`, `mfa:backup-codes:generate`, etc.) — both resolve to the same command.
|
|
57
|
+
|
|
58
|
+
Tenant policy admin (reads/mutates the tenant's rules, not a user's enrollment):
|
|
59
|
+
|
|
60
|
+
| Command | What |
|
|
61
|
+
|---|---|
|
|
62
|
+
| `blocks mfa config get [--json]` | Reads the tenant's MFA policy. |
|
|
63
|
+
| `blocks mfa config save [--enable] [--require-for-all-users] [--allow-user-opt-out] [--allow-backup-codes] [--backup-codes-count <n>] [--user-mfa-type 0,1] [--required-roles a,b] [--exempt-roles a,b] [--body '<json>'\|--file <path>] [--dry-run] [--yes] [--json]` | Saves the tenant's MFA policy. `--body`/`--file` supplies a base JSON payload; any convenience flag also passed overwrites the matching key on top of it. Requires `--dry-run` (preview only) or `--yes`/an interactive `yes` before it executes. |
|
|
64
|
+
|
|
65
|
+
Self-service enrollment, challenge, and recovery for the calling (impersonated) user:
|
|
66
|
+
|
|
67
|
+
| Command | What |
|
|
68
|
+
|---|---|
|
|
69
|
+
| `blocks mfa totp setup [--json]` | Starts TOTP enrollment; prints IAM's secret/QR payload. |
|
|
70
|
+
| `blocks mfa totp verify-setup <code> [--json]` | Confirms TOTP enrollment with the 6-digit code. |
|
|
71
|
+
| `blocks mfa totp enable --mfa-type <n> [--code <c>] [--dry-run] [--yes] [--json]` | Composed enrollment — see below. |
|
|
72
|
+
| `blocks mfa generate --mfa-type <n> [--send-phone-number-as-email-domain <domain>] [--json]` | Sends an OTP challenge; returns an `mfaId` to pass to `resend`/`verify`. |
|
|
73
|
+
| `blocks mfa resend <mfaId> [--send-phone-number-as-email-domain <domain>] [--json]` | Re-sends a pending OTP. |
|
|
74
|
+
| `blocks mfa verify <mfaId> <code> --auth-type <n> [--from-token-call] [--json]` | Confirms an OTP/step-up challenge. |
|
|
75
|
+
| `blocks mfa method set --mfa-type <n> [--json]` | Switches the impersonated user's active MFA method. |
|
|
76
|
+
| `blocks mfa disable [--dry-run] [--yes] [--json]` | Disables MFA for the impersonated user. Mutating: needs `--dry-run` or `--yes`. |
|
|
77
|
+
| `blocks mfa backup-codes list [--json]` | Lists the impersonated user's backup codes. Read-only. |
|
|
78
|
+
| `blocks mfa backup-codes generate [--dry-run] [--yes] [--json]` | Generates a fresh set, invalidating existing ones. Mutating: needs `--dry-run` or `--yes`. |
|
|
79
|
+
| `blocks mfa backup-codes use <userId> <code> [--json]` | Consumes one backup code. |
|
|
80
|
+
|
|
81
|
+
```sh
|
|
82
|
+
blocks mfa config get --json # check tenant policy before prompting enrollment
|
|
83
|
+
blocks mfa totp setup # prints secret/QR
|
|
84
|
+
blocks mfa totp verify-setup 123456
|
|
85
|
+
blocks mfa method set --mfa-type 0
|
|
86
|
+
blocks mfa backup-codes generate --dry-run # preview, no call
|
|
87
|
+
blocks mfa backup-codes generate --yes # after explicit confirmation
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## The composed `mfa totp enable` command
|
|
91
|
+
|
|
92
|
+
`mfa totp enable --mfa-type <n>` chains the individual TOTP steps into one enrollment sitting, with one confirmation, rather than four separate commands run at different times:
|
|
93
|
+
|
|
94
|
+
`totp setup` → prints the QR/secret → **verification code** (from `--code`, or an interactive prompt if omitted) → `totp verify-setup <code>` → `method set --mfa-type <n>` → `backup-codes generate --yes`.
|
|
95
|
+
|
|
96
|
+
Two things worth calling out precisely, both confirmed against source:
|
|
97
|
+
|
|
98
|
+
- **`--mfa-type` is required, never defaulted.** The numeric value that means "TOTP" for a given tenant isn't documented anywhere in this CLI or SDK (the same opaque-integer caveat as `mfa generate`/`method set` above) — the command throws rather than guessing one. Look it up (e.g. via `mfa config get`, or ask the user) instead of assuming a value like `0`.
|
|
99
|
+
- **Two separate prompts can block a non-interactive run**, not just one: the command asks the operator to type `yes` before it starts (skipped by `--yes`, same as `--dry-run`), and then, independently, if `--code` isn't passed, it prompts for the verification code from stdin with no timeout — in a non-interactive/agent context with no TTY to answer it, this hangs indefinitely rather than failing fast. An agent or script running this command must pass **both** `--yes` and `--code <c>` (the code sourced from wherever the authenticator output is captured) to avoid a hang.
|
|
100
|
+
- `--dry-run` short-circuits before either prompt and before any network call: it prints the planned step list (`mfa:totp:setup`, the scan/enter-code step, `mfa:totp:verify-setup <code>`, `mfa:method:set <n>`, `mfa:backup-codes:generate`) and exits.
|
|
101
|
+
|
|
102
|
+
Deliberately excluded from this composed command: `mfa config save`. That's the separate tenant-wide policy action covered above, not part of enrolling one user.
|
|
103
|
+
|
|
104
|
+
## Gotchas
|
|
105
|
+
|
|
106
|
+
- **`config`/`saveConfig` (SDK) and `mfa config get`/`config save` (CLI) are tenant policy, not a user's enrollment state.** Don't call these expecting to see or change one user's MFA status — that's every other method/command in this file.
|
|
107
|
+
- **`mfaType`/`authType` are opaque, tenant-defined integers.** Neither the SDK's types nor the CLI documents what number means "TOTP," "SMS," or "email" — confirm against the tenant's own IAM config rather than guessing.
|
|
108
|
+
- **`mfa totp enable` can hang waiting on stdin twice over** if run non-interactively without `--yes` and `--code` — see above. Always pass both when scripting or agent-driving this command.
|
|
109
|
+
- **Backup codes are shown once.** Treat `backupCodes.generate()` / `mfa backup-codes generate`'s response as sensitive; there's no re-display endpoint for the raw codes, only `list()`/`backup-codes list`, which is for a remaining-count style view, not for recovering codes you didn't save.
|
|
110
|
+
- **No admin "force MFA on this specific user" capability was found in this source.** The nearest thing is tenant-wide, role-based policy (`mfaRequiredRoles`/`mfaExemptRoles` via `saveConfig`/`config save`), which targets a role, not a user id. If a request needs a specific other user's MFA changed, that's out of this skill's scope — don't fabricate an endpoint to satisfy it.
|
|
111
|
+
- **Every `mfa` CLI command is project-scoped and impersonation-only**, same rule as the rest of the project-scoped CLI surface — `blocks use <tenantId>` first, or commands fail with `project_not_selected`.
|
|
112
|
+
- **Mutating CLI commands (`config save`, `disable`, `backup-codes generate`, and the composed `totp enable`) require `--dry-run` or `--yes`/an interactive `yes`** before they execute — apply the same confirm-before-mutating discipline an agent uses for any other mutating Blocks CLI command: state the exact change and get explicit go-ahead first.
|
|
113
|
+
|
|
114
|
+
## Example trigger prompts
|
|
115
|
+
|
|
116
|
+
- "Let a signed-in user enroll in authenticator-app (TOTP) MFA."
|
|
117
|
+
- "Build the MFA settings screen: enroll, switch method, disable, view backup codes."
|
|
118
|
+
- "Check whether this tenant requires MFA before showing the enrollment prompt."
|
|
119
|
+
- "Turn on MFA for the whole tenant and require it for the admin role."
|
|
120
|
+
- "Send an OTP code to the user and verify what they typed."
|
|
121
|
+
- "Let a user regenerate their MFA backup codes."
|
|
122
|
+
- "From the terminal, enroll the current project's impersonated user in TOTP MFA end to end."
|
|
123
|
+
- "Run TOTP enrollment non-interactively from a script" → pass both `--yes` and `--code <c>` to `blocks mfa totp enable`, never run it unattended without them.
|
|
124
|
+
- "Read the tenant's current MFA policy from the CLI."
|
|
@@ -1,43 +1,43 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: blocks-iam-organizations
|
|
3
|
-
description: "Work with organizations (multi-tenant workspaces) via `iam.organizations`/`iam.signupSettings`/`auth.switchOrganization` (SDK, in-app) or `blocks iam organizations *`/`iam signup-settings *` (CLI, project-scoped, `--dry-run`→`--yes`) — never raw fetch/curl. Covers the org switcher, switching active org context (SDK/app-only, no CLI equivalent), public signup policy, and — human-confirmed only — creating/editing organizations and org/signup config. Use for 'org switcher', 'switch organization', 'multi-org', 'create/update an organization', 'organization settings', 'signup settings'. Users/roles within an org are blocks-iam-users/blocks-iam-access-control; SSO/OIDC client setup is blocks-onboarding, portal-optional now."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Blocks IAM — Organizations
|
|
7
|
-
|
|
8
|
-
Organizations are the tenancy/workspace unit inside a Blocks project. Two equally real surfaces exist for managing them:
|
|
9
|
-
|
|
10
|
-
- **Inside a Blocks app** — `@seliseblocks/client` SDK calls from app code (`blocksClient` in `src/lib/blocks/client.ts`, from `blocks new web`). Never write raw `fetch`/`curl` against Blocks APIs.
|
|
11
|
-
- **Outside an app UI** — scripting, one-off inspection, CI, an ops task — the `blocks` CLI has a real, project-scoped command surface for the same operations: `blocks iam organizations list/get/create/update/my/config get/config save` and `blocks iam signup-settings get/save`.
|
|
12
|
-
|
|
13
|
-
The one thing neither surface papers over as a gap is `auth.switchOrganization` — there is no `blocks iam organizations switch` or similar; switching the *active session's* org context only makes sense from inside the app that owns that session, so it stays SDK-only.
|
|
14
|
-
|
|
15
|
-
**Prerequisite:** the app is a `blocks new web` scaffold with a project selected. If auth/project state is unknown, run the blocks-onboarding skill first.
|
|
16
|
-
|
|
17
|
-
## The platform boundary — read this before writing any admin-CRUD call
|
|
18
|
-
|
|
19
|
-
Full organization management (create, update, config, signup-settings) **is** exposed today, on both surfaces above. What's restricted isn't the surface but *who authorizes a mutation and when* — organizations are a tenant-isolation boundary, so creating or reconfiguring them carries the same "human explicitly directs this specific change" discipline as the portal-only OIDC provisioning in blocks-onboarding, just enforced on two different mechanisms (SDK call vs. CLI command) instead of one.
|
|
20
|
-
|
|
21
|
-
Concretely: **before wiring up or invoking any `create`/`update`/`saveConfig`/`save` call — SDK or CLI — restate the exact change back to the user in plain terms (which organization, which fields, old value vs. new value) and get an explicit go-ahead.** Never something an agent calls on its own initiative, in an unattended script, or as a side effect of some other task.
|
|
22
|
-
|
|
23
|
-
## Two flows
|
|
24
|
-
|
|
25
|
-
- **[flows/read-and-switch.md](flows/read-and-switch.md)** — the org switcher (`organizations.my`), switching active org context (`auth.switchOrganization`, SDK-only), and public signup policy (`signupSettings.get`). Safe, no special caveat.
|
|
26
|
-
- **[flows/admin-mutations.md](flows/admin-mutations.md)** — creating/editing organizations, org-level config, and signup policy, on both the SDK and CLI surfaces, including the full CLI command reference. Sensitive — human-confirmed only.
|
|
27
|
-
|
|
28
|
-
## Gotchas
|
|
29
|
-
|
|
30
|
-
- **The CLI has real organization/signup-settings commands** — don't tell a user there's no `blocks` command for organizations.
|
|
31
|
-
- **The one genuine gap is `switchOrganization`** — SDK/app-only, no CLI equivalent, don't invent one.
|
|
32
|
-
- **Confirm the payload, not just the intent**, before any mutating call — SDK or CLI. See [flows/admin-mutations.md](flows/admin-mutations.md) for the full discipline.
|
|
33
|
-
- **Multi-org must be enabled** (`isMultiOrgEnabled`) for switching orgs to be meaningful — check this first if a user reports "switching doesn't do anything."
|
|
34
|
-
|
|
35
|
-
## Example trigger prompts
|
|
36
|
-
|
|
37
|
-
- "Add an org switcher to the sidebar using the current user's organizations." → read-and-switch
|
|
38
|
-
- "Let a multi-org user switch which organization they're working in." → read-and-switch
|
|
39
|
-
- "Show the tenant's signup policy on our public signup page." → read-and-switch
|
|
40
|
-
- "Build an admin screen to create a new organization." → admin-mutations (confirm the fields with the user before calling `create`)
|
|
41
|
-
- "Turn on multi-org for this project." → admin-mutations (read `getConfig`/`config get` first, confirm the change, then save)
|
|
42
|
-
- "Is there a `blocks` command to list organizations?" → yes, `blocks iam organizations list` (project-scoped, requires `blocks use <tenantId>` first); use the SDK instead only when the ask is a feature inside the app itself.
|
|
43
|
-
- "Is there a CLI way to switch which organization I'm working in?" → no, that's the one gap — `auth.switchOrganization` is SDK/app-only since it mutates the calling session's own tokens.
|
|
1
|
+
---
|
|
2
|
+
name: blocks-iam-organizations
|
|
3
|
+
description: "Work with organizations (multi-tenant workspaces) via `iam.organizations`/`iam.signupSettings`/`auth.switchOrganization` (SDK, in-app) or `blocks iam organizations *`/`iam signup-settings *` (CLI, project-scoped, `--dry-run`→`--yes`) — never raw fetch/curl. Covers the org switcher, switching active org context (SDK/app-only, no CLI equivalent), public signup policy, and — human-confirmed only — creating/editing organizations and org/signup config. Use for 'org switcher', 'switch organization', 'multi-org', 'create/update an organization', 'organization settings', 'signup settings'. Users/roles within an org are blocks-iam-users/blocks-iam-access-control; SSO/OIDC client setup is blocks-onboarding, portal-optional now."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Blocks IAM — Organizations
|
|
7
|
+
|
|
8
|
+
Organizations are the tenancy/workspace unit inside a Blocks project. Two equally real surfaces exist for managing them:
|
|
9
|
+
|
|
10
|
+
- **Inside a Blocks app** — `@seliseblocks/client` SDK calls from app code (`blocksClient` in `src/lib/blocks/client.ts`, from `blocks new web`). Never write raw `fetch`/`curl` against Blocks APIs.
|
|
11
|
+
- **Outside an app UI** — scripting, one-off inspection, CI, an ops task — the `blocks` CLI has a real, project-scoped command surface for the same operations: `blocks iam organizations list/get/create/update/my/config get/config save` and `blocks iam signup-settings get/save`.
|
|
12
|
+
|
|
13
|
+
The one thing neither surface papers over as a gap is `auth.switchOrganization` — there is no `blocks iam organizations switch` or similar; switching the *active session's* org context only makes sense from inside the app that owns that session, so it stays SDK-only.
|
|
14
|
+
|
|
15
|
+
**Prerequisite:** the app is a `blocks new web` scaffold with a project selected. If auth/project state is unknown, run the blocks-onboarding skill first.
|
|
16
|
+
|
|
17
|
+
## The platform boundary — read this before writing any admin-CRUD call
|
|
18
|
+
|
|
19
|
+
Full organization management (create, update, config, signup-settings) **is** exposed today, on both surfaces above. What's restricted isn't the surface but *who authorizes a mutation and when* — organizations are a tenant-isolation boundary, so creating or reconfiguring them carries the same "human explicitly directs this specific change" discipline as the portal-only OIDC provisioning in blocks-onboarding, just enforced on two different mechanisms (SDK call vs. CLI command) instead of one.
|
|
20
|
+
|
|
21
|
+
Concretely: **before wiring up or invoking any `create`/`update`/`saveConfig`/`save` call — SDK or CLI — restate the exact change back to the user in plain terms (which organization, which fields, old value vs. new value) and get an explicit go-ahead.** Never something an agent calls on its own initiative, in an unattended script, or as a side effect of some other task.
|
|
22
|
+
|
|
23
|
+
## Two flows
|
|
24
|
+
|
|
25
|
+
- **[flows/read-and-switch.md](flows/read-and-switch.md)** — the org switcher (`organizations.my`), switching active org context (`auth.switchOrganization`, SDK-only), and public signup policy (`signupSettings.get`). Safe, no special caveat.
|
|
26
|
+
- **[flows/admin-mutations.md](flows/admin-mutations.md)** — creating/editing organizations, org-level config, and signup policy, on both the SDK and CLI surfaces, including the full CLI command reference. Sensitive — human-confirmed only.
|
|
27
|
+
|
|
28
|
+
## Gotchas
|
|
29
|
+
|
|
30
|
+
- **The CLI has real organization/signup-settings commands** — don't tell a user there's no `blocks` command for organizations.
|
|
31
|
+
- **The one genuine gap is `switchOrganization`** — SDK/app-only, no CLI equivalent, don't invent one.
|
|
32
|
+
- **Confirm the payload, not just the intent**, before any mutating call — SDK or CLI. See [flows/admin-mutations.md](flows/admin-mutations.md) for the full discipline.
|
|
33
|
+
- **Multi-org must be enabled** (`isMultiOrgEnabled`) for switching orgs to be meaningful — check this first if a user reports "switching doesn't do anything."
|
|
34
|
+
|
|
35
|
+
## Example trigger prompts
|
|
36
|
+
|
|
37
|
+
- "Add an org switcher to the sidebar using the current user's organizations." → read-and-switch
|
|
38
|
+
- "Let a multi-org user switch which organization they're working in." → read-and-switch
|
|
39
|
+
- "Show the tenant's signup policy on our public signup page." → read-and-switch
|
|
40
|
+
- "Build an admin screen to create a new organization." → admin-mutations (confirm the fields with the user before calling `create`)
|
|
41
|
+
- "Turn on multi-org for this project." → admin-mutations (read `getConfig`/`config get` first, confirm the change, then save)
|
|
42
|
+
- "Is there a `blocks` command to list organizations?" → yes, `blocks iam organizations list` (project-scoped, requires `blocks use <tenantId>` first); use the SDK instead only when the ask is a feature inside the app itself.
|
|
43
|
+
- "Is there a CLI way to switch which organization I'm working in?" → no, that's the one gap — `auth.switchOrganization` is SDK/app-only since it mutates the calling session's own tokens.
|
|
@@ -1,89 +1,89 @@
|
|
|
1
|
-
# Flow: Admin-CRUD surface — confirm the exact change first
|
|
2
|
-
|
|
3
|
-
These mutate tenant-level state. Build them as an explicit feature in an admin settings screen (SDK), or run them as an operator from a terminal with a reviewed `--dry-run` (CLI). Both surfaces exist and are equally real — see "The platform boundary" in [SKILL.md](../SKILL.md).
|
|
4
|
-
|
|
5
|
-
## SDK methods
|
|
6
|
-
|
|
7
|
-
### `organizations.list(query)` / `organizations.get(id)` — browse and inspect
|
|
8
|
-
|
|
9
|
-
Read-only, so no confirmation is needed to call them — but they're part of the admin org-management surface (browsing arbitrary orgs, not just "my own"), so gate the screen itself behind whatever admin permission the app already checks. Typical use: an org-picker/detail view feeding into an edit form, populated before a `create`/`update` call.
|
|
10
|
-
|
|
11
|
-
```ts
|
|
12
|
-
const page = await blocksClient.iam.organizations.list({ Page: 1, PageSize: 20, "Filter.Name": search });
|
|
13
|
-
const org = await blocksClient.iam.organizations.get(organizationId);
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
### `organizations.create(request)` / `organizations.update(id, request)`
|
|
17
|
-
|
|
18
|
-
Create/edit an organization's record (name, description, contact info, branding, addresses, default roles/permissions for new members, etc. — verify current field names against what the admin UI/API actually accepts rather than assuming they haven't changed).
|
|
19
|
-
|
|
20
|
-
```ts
|
|
21
|
-
// Only after the admin has reviewed and confirmed this exact payload:
|
|
22
|
-
await blocksClient.iam.organizations.create({
|
|
23
|
-
name: "Acme Logistics",
|
|
24
|
-
description: "Acme's logistics division workspace"
|
|
25
|
-
// ...remaining fields the user confirmed
|
|
26
|
-
});
|
|
27
|
-
|
|
28
|
-
await blocksClient.iam.organizations.update(organizationId, {
|
|
29
|
-
name: "Acme Logistics (Renamed)"
|
|
30
|
-
// ...only the fields the user asked to change
|
|
31
|
-
});
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
### `organizations.getConfig()` / `organizations.saveConfig(request)` — org-level settings
|
|
35
|
-
|
|
36
|
-
Project/org-wide policy, including multi-org enablement. Read the current config first, show the user the diff of what would change, then save.
|
|
37
|
-
|
|
38
|
-
```ts
|
|
39
|
-
const current = await blocksClient.iam.organizations.getConfig();
|
|
40
|
-
// ...user reviews current vs. proposed, confirms...
|
|
41
|
-
await blocksClient.iam.organizations.saveConfig({
|
|
42
|
-
...current,
|
|
43
|
-
isMultiOrgEnabled: true
|
|
44
|
-
});
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
### `signupSettings.save(request)` — save signup policy
|
|
48
|
-
|
|
49
|
-
Same confirm-first rule: this changes what the public signup screen allows for every future visitor, so restate the exact policy change (e.g., "turn on org creation from signup") before calling.
|
|
50
|
-
|
|
51
|
-
```ts
|
|
52
|
-
await blocksClient.iam.signupSettings.save({
|
|
53
|
-
...currentSettings,
|
|
54
|
-
allowOrgCreationFromSignup: true
|
|
55
|
-
});
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
## CLI surface — scripting/inspection, outside an app UI
|
|
59
|
-
|
|
60
|
-
For anything that isn't a feature inside a running Blocks app (one-off lookups, ops scripts, CI checks), the `blocks` CLI has a matching, project-scoped command for every SDK method above except `switchOrganization` (see [read-and-switch.md](read-and-switch.md)). Every command below requires a project already selected (`blocks use <tenantId>`) — they all call IAM through an impersonated project token via `selectedProject()`, the same tenant scoping the SDK calls get from the app's own session.
|
|
61
|
-
|
|
62
|
-
| CLI command | Maps to | Notes |
|
|
63
|
-
|---|---|---|
|
|
64
|
-
| `blocks iam organizations list` | `organizations.list()` | `--search`, `--is-disabled`, `--parent-organization-id`, `--ids <a,b>`, `--page`, `--page-size`, `--sort-by`, `--sort-desc`. Read-only. |
|
|
65
|
-
| `blocks iam organizations get <id>` (or `--id`) | `organizations.get(id)` | Read-only. |
|
|
66
|
-
| `blocks iam organizations my` | `organizations.my()` | Read-only. |
|
|
67
|
-
| `blocks iam organizations create --name <n> [...]` | `organizations.create()` | `--name` (required), `--description`, `--email`, `--phone-number`, `--website-url`, `--default-permissions`, `--default-roles`, or a full `--body '<json>'`/`--file <path.json>`. Mutation. |
|
|
68
|
-
| `blocks iam organizations update <id> [...]` | `organizations.update(id, ...)` | `--name`, `--description`, `--email`, `--phone-number`, `--website-url`, `--currency`, `--industry`, `--locale`, `--time-zone`, `--is-enabled`, or `--body`/`--file`. Mutation. |
|
|
69
|
-
| `blocks iam organizations config get` | `organizations.getConfig()` | Read-only. |
|
|
70
|
-
| `blocks iam organizations config save [...]` | `organizations.saveConfig()` | `--multi-org-enabled`, `--consent-for-multi-org-enable`, `--allow-org-creation-from-signup`, `--allow-org-creation-from-portal`, `--allow-org-creation-from-cloud`, `--allow-org-creation-from-construct`, or `--body`/`--file`. Mutation. |
|
|
71
|
-
| `blocks iam signup-settings get` | `signupSettings.get()` | Read-only. |
|
|
72
|
-
| `blocks iam signup-settings save [...]` | `signupSettings.save()` | `--email-password-signup`, `--sso-signup`, `--default-permissions`, `--default-roles`, or `--body`/`--file`. Mutation. |
|
|
73
|
-
|
|
74
|
-
```bash
|
|
75
|
-
blocks use <tenantId> # select the project once per session
|
|
76
|
-
blocks iam organizations list --search acme --json
|
|
77
|
-
blocks iam organizations config get --json
|
|
78
|
-
blocks iam organizations config save --multi-org-enabled --dry-run # review the request body first
|
|
79
|
-
blocks iam organizations config save --multi-org-enabled --yes # only after the user confirms
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
Every mutating command (`create`, `update`, `config save`, `signup-settings save`) supports `--dry-run` (prints the resolved request body without calling the API) and requires either `--yes` or an interactive `yes` at a confirmation prompt to actually run — the same "state the exact change, get an explicit go-ahead" discipline as the SDK guidance above, just enforced by the CLI itself instead of app code you write.
|
|
83
|
-
|
|
84
|
-
## Gotchas
|
|
85
|
-
|
|
86
|
-
- **The CLI has real organization/signup-settings commands** — don't tell a user there's no `blocks` command for organizations; there is, it's just project-scoped and separate from the SDK path used inside an app.
|
|
87
|
-
- **Confirm the payload, not just the intent**, before any `create`/`update`/`saveConfig`/`signupSettings.save` call — SDK or CLI — restate which organization and which fields are changing, old value vs. new, and wait for a clear yes. On the CLI this means running with `--dry-run` first and only adding `--yes` after that review.
|
|
88
|
-
- **These are legitimate app/operator features, not agent shortcuts.** It's fine to build a "Create Organization" admin screen with a confirm dialog, or run the CLI command yourself with a human's go-ahead — that's the intended use. It's not fine for an agent to call `organizations.create`/`saveConfig` (CLI or SDK) on its own initiative (e.g., to "set things up" for a demo) without that human-in-the-loop step.
|
|
89
|
-
- **Different response shapes per call** — `my()`/`list()` return an array-shaped payload, `get(id)` returns a single organization, `create` returns an id. Don't assume a single envelope shape across all of them; check the actual response before wiring UI to a field path.
|
|
1
|
+
# Flow: Admin-CRUD surface — confirm the exact change first
|
|
2
|
+
|
|
3
|
+
These mutate tenant-level state. Build them as an explicit feature in an admin settings screen (SDK), or run them as an operator from a terminal with a reviewed `--dry-run` (CLI). Both surfaces exist and are equally real — see "The platform boundary" in [SKILL.md](../SKILL.md).
|
|
4
|
+
|
|
5
|
+
## SDK methods
|
|
6
|
+
|
|
7
|
+
### `organizations.list(query)` / `organizations.get(id)` — browse and inspect
|
|
8
|
+
|
|
9
|
+
Read-only, so no confirmation is needed to call them — but they're part of the admin org-management surface (browsing arbitrary orgs, not just "my own"), so gate the screen itself behind whatever admin permission the app already checks. Typical use: an org-picker/detail view feeding into an edit form, populated before a `create`/`update` call.
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
const page = await blocksClient.iam.organizations.list({ Page: 1, PageSize: 20, "Filter.Name": search });
|
|
13
|
+
const org = await blocksClient.iam.organizations.get(organizationId);
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
### `organizations.create(request)` / `organizations.update(id, request)`
|
|
17
|
+
|
|
18
|
+
Create/edit an organization's record (name, description, contact info, branding, addresses, default roles/permissions for new members, etc. — verify current field names against what the admin UI/API actually accepts rather than assuming they haven't changed).
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
// Only after the admin has reviewed and confirmed this exact payload:
|
|
22
|
+
await blocksClient.iam.organizations.create({
|
|
23
|
+
name: "Acme Logistics",
|
|
24
|
+
description: "Acme's logistics division workspace"
|
|
25
|
+
// ...remaining fields the user confirmed
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
await blocksClient.iam.organizations.update(organizationId, {
|
|
29
|
+
name: "Acme Logistics (Renamed)"
|
|
30
|
+
// ...only the fields the user asked to change
|
|
31
|
+
});
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### `organizations.getConfig()` / `organizations.saveConfig(request)` — org-level settings
|
|
35
|
+
|
|
36
|
+
Project/org-wide policy, including multi-org enablement. Read the current config first, show the user the diff of what would change, then save.
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
const current = await blocksClient.iam.organizations.getConfig();
|
|
40
|
+
// ...user reviews current vs. proposed, confirms...
|
|
41
|
+
await blocksClient.iam.organizations.saveConfig({
|
|
42
|
+
...current,
|
|
43
|
+
isMultiOrgEnabled: true
|
|
44
|
+
});
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### `signupSettings.save(request)` — save signup policy
|
|
48
|
+
|
|
49
|
+
Same confirm-first rule: this changes what the public signup screen allows for every future visitor, so restate the exact policy change (e.g., "turn on org creation from signup") before calling.
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
await blocksClient.iam.signupSettings.save({
|
|
53
|
+
...currentSettings,
|
|
54
|
+
allowOrgCreationFromSignup: true
|
|
55
|
+
});
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## CLI surface — scripting/inspection, outside an app UI
|
|
59
|
+
|
|
60
|
+
For anything that isn't a feature inside a running Blocks app (one-off lookups, ops scripts, CI checks), the `blocks` CLI has a matching, project-scoped command for every SDK method above except `switchOrganization` (see [read-and-switch.md](read-and-switch.md)). Every command below requires a project already selected (`blocks use <tenantId>`) — they all call IAM through an impersonated project token via `selectedProject()`, the same tenant scoping the SDK calls get from the app's own session.
|
|
61
|
+
|
|
62
|
+
| CLI command | Maps to | Notes |
|
|
63
|
+
|---|---|---|
|
|
64
|
+
| `blocks iam organizations list` | `organizations.list()` | `--search`, `--is-disabled`, `--parent-organization-id`, `--ids <a,b>`, `--page`, `--page-size`, `--sort-by`, `--sort-desc`. Read-only. |
|
|
65
|
+
| `blocks iam organizations get <id>` (or `--id`) | `organizations.get(id)` | Read-only. |
|
|
66
|
+
| `blocks iam organizations my` | `organizations.my()` | Read-only. |
|
|
67
|
+
| `blocks iam organizations create --name <n> [...]` | `organizations.create()` | `--name` (required), `--description`, `--email`, `--phone-number`, `--website-url`, `--default-permissions`, `--default-roles`, or a full `--body '<json>'`/`--file <path.json>`. Mutation. |
|
|
68
|
+
| `blocks iam organizations update <id> [...]` | `organizations.update(id, ...)` | `--name`, `--description`, `--email`, `--phone-number`, `--website-url`, `--currency`, `--industry`, `--locale`, `--time-zone`, `--is-enabled`, or `--body`/`--file`. Mutation. |
|
|
69
|
+
| `blocks iam organizations config get` | `organizations.getConfig()` | Read-only. |
|
|
70
|
+
| `blocks iam organizations config save [...]` | `organizations.saveConfig()` | `--multi-org-enabled`, `--consent-for-multi-org-enable`, `--allow-org-creation-from-signup`, `--allow-org-creation-from-portal`, `--allow-org-creation-from-cloud`, `--allow-org-creation-from-construct`, or `--body`/`--file`. Mutation. |
|
|
71
|
+
| `blocks iam signup-settings get` | `signupSettings.get()` | Read-only. |
|
|
72
|
+
| `blocks iam signup-settings save [...]` | `signupSettings.save()` | `--email-password-signup`, `--sso-signup`, `--default-permissions`, `--default-roles`, or `--body`/`--file`. Mutation. |
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
blocks use <tenantId> # select the project once per session
|
|
76
|
+
blocks iam organizations list --search acme --json
|
|
77
|
+
blocks iam organizations config get --json
|
|
78
|
+
blocks iam organizations config save --multi-org-enabled --dry-run # review the request body first
|
|
79
|
+
blocks iam organizations config save --multi-org-enabled --yes # only after the user confirms
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Every mutating command (`create`, `update`, `config save`, `signup-settings save`) supports `--dry-run` (prints the resolved request body without calling the API) and requires either `--yes` or an interactive `yes` at a confirmation prompt to actually run — the same "state the exact change, get an explicit go-ahead" discipline as the SDK guidance above, just enforced by the CLI itself instead of app code you write.
|
|
83
|
+
|
|
84
|
+
## Gotchas
|
|
85
|
+
|
|
86
|
+
- **The CLI has real organization/signup-settings commands** — don't tell a user there's no `blocks` command for organizations; there is, it's just project-scoped and separate from the SDK path used inside an app.
|
|
87
|
+
- **Confirm the payload, not just the intent**, before any `create`/`update`/`saveConfig`/`signupSettings.save` call — SDK or CLI — restate which organization and which fields are changing, old value vs. new, and wait for a clear yes. On the CLI this means running with `--dry-run` first and only adding `--yes` after that review.
|
|
88
|
+
- **These are legitimate app/operator features, not agent shortcuts.** It's fine to build a "Create Organization" admin screen with a confirm dialog, or run the CLI command yourself with a human's go-ahead — that's the intended use. It's not fine for an agent to call `organizations.create`/`saveConfig` (CLI or SDK) on its own initiative (e.g., to "set things up" for a demo) without that human-in-the-loop step.
|
|
89
|
+
- **Different response shapes per call** — `my()`/`list()` return an array-shaped payload, `get(id)` returns a single organization, `create` returns an id. Don't assume a single envelope shape across all of them; check the actual response before wiring UI to a field path.
|