Admin automation: a published API reference and a scoped credential for provisioning #1108
Closed
opened 2026-11-04 03:11:35 +00:00 by Cordy
·
5 comments
No Branch/Tag specified
main
b12v07
b11v07
b10v07
ci-rc-publish
fx15-s3dry
b9v07
b8v07
bench742
b7v07
legal-texts-v0.2
b6v07
b5v07
b4v07
b3v07
sx1139
st742
b2v07
ix1102
fu1098
zp1097
wd1099
tr1100
qf1077
nc1070
ci1
rp1072
lk1073
ab1071
fi1074
si1070
ra1054
wo1056
oc1057
tf1055
sv1063
fg1059
st1058
fs929
mu1039
ls1033
cf975
lf835
dx1023
ml896
a11y2
av1022
r913
r7
r6
r5
r45
r23
r1
b10
b9
fix-b5
fix-b4
fix-b3
fix-b2
fix-b1
fix-922
fix-923
fix-911
fix-343b
batch-a
v0.6.413
v0.6.412
v0.6.411
v0.6.410
v0.6.409
v0.6.408
v0.6.407
v0.6.406
v0.6.405
v0.6.404
v0.6.403
v0.6.402
v0.6.401
v0.6.400
v0.6.399
v0.6.398
v0.6.397
v0.6.396
v0.6.395
v0.6.394
v0.6.393
v0.6.392
v0.6.391
v0.6.390
v0.6.389
v0.6.388
v0.6.387
v0.6.386
v0.6.385
v0.6.384
v0.6.383
v0.6.382
v0.6.381
v0.6.380
v0.6.379
v0.6.378
v0.6.377
v0.6.376
v0.6.375
v0.6.374
v0.6.373
v0.6.372
v0.6.371
v0.6.370
v0.6.369
v0.6.368
v0.6.367
v0.6.366
v0.6.365
v0.6.364
v0.6.363
v0.6.362
v0.6.361
v0.6.360
v0.6.359
v0.6.358
v0.6.357
v0.6.356
v0.6.355
v0.6.354
v0.6.353
v0.6.352
v0.6.351
v0.6.350
v0.6.349
v0.6.348
v0.6.347
v0.6.346
v0.6.345
v0.6.344
v0.6.343
v0.6.342
v0.6.341
v0.6.340
v0.6.339
v0.6.338
v0.6.337
v0.6.336
v0.6.335
v0.6.334
v0.6.333
v0.6.332
v0.6.331
v0.6.330
v0.6.329
v0.6.328
v0.6.327
v0.6.326
v0.6.325
v0.6.324
v0.6.323
v0.6.322
v0.6.321
v0.6.320
v0.6.319
v0.6.318
v0.6.317
v0.6.316
v0.6.315
v0.6.314
v0.6.313
v0.6.312
v0.6.311
v0.6.310
v0.6.309
v0.6.308
v0.6.307
v0.6.306
v0.6.305
v0.6.304
v0.6.303
v0.6.302
v0.6.301
v0.6.300
v0.6.299
v0.6.298
v0.6.297
v0.6.296
v0.6.295
v0.6.294
v0.6.293
v0.6.292
v0.6.291
v0.6.290
v0.6.289
v0.6.288
v0.6.287
v0.6.286
v0.6.285
v0.6.284
v0.6.283
v0.6.282
v0.6.281
v0.6.280
v0.6.279
v0.6.278
v0.6.277
v0.6.276
v0.6.275
v0.6.274
v0.6.273
v0.6.272
v0.6.271
v0.6.270
v0.6.269
v0.6.268
v0.6.267
v0.6.266
v0.6.265
v0.6.264
v0.6.263
v0.6.262
v0.6.261
v0.6.260
v0.6.259
v0.6.258
v0.6.257
v0.6.256
v0.6.255
v0.6.254
v0.6.253
v0.6.252
v0.6.251
v0.6.250
v0.6.249
v0.6.248
v0.6.247
v0.6.246
v0.6.245
v0.6.244
v0.6.243
v0.6.242
v0.6.241
v0.6.240
v0.6.239
v0.6.238
v0.6.237
v0.6.236
v0.6.235
v0.6.234
v0.6.233
v0.6.232
v0.6.231
v0.6.230
v0.6.229
v0.6.228
v0.6.227
v0.6.226
v0.6.225
v0.6.224
v0.6.223
v0.6.222
v0.6.221
v0.6.220
v0.6.219
v0.6.218
v0.6.217
v0.6.216
v0.6.215
v0.6.214
v0.6.213
v0.6.212
v0.6.211
v0.6.210
v0.6.209
v0.6.208
v0.6.207
v0.6.206
v0.6.205
v0.6.204
v0.6.203
v0.6.202
v0.6.201
v0.6.200
v0.6.199
v0.6.198
v0.6.197
v0.6.196
v0.6.195
v0.6.194
v0.6.193
v0.6.192
v0.6.191
v0.6.190
v0.6.189
v0.6.188
v0.6.187
v0.6.186
v0.6.185
v0.6.184
v0.6.183
v0.6.182
v0.6.181
v0.6.180
v0.6.179
v0.6.178
v0.6.177
v0.6.176
v0.6.175
v0.6.174
v0.6.173
v0.6.172
v0.6.171
v0.6.170
v0.6.169
v0.6.168
v0.6.167
v0.6.166
v0.6.165
v0.6.164
v0.6.163
v0.6.162
v0.6.161
v0.6.160
v0.6.159
v0.6.158
v0.6.157
v0.6.156
v0.6.155
v0.6.154
v0.6.153
v0.6.152
v0.6.151
v0.6.150
v0.6.149
v0.6.148
v0.6.147
v0.6.146
v0.6.145
v0.6.144
v0.6.143
v0.6.142
v0.6.141
v0.6.140
v0.6.139
v0.6.138
v0.6.137
v0.6.136
v0.6.135
v0.6.134
v0.6.133
v0.6.132
v0.6.131
v0.6.130
v0.6.129
v0.6.128
v0.6.127
v0.6.126
v0.6.125
v0.6.124
v0.6.123
v0.6.122
v0.6.121
v0.6.120
v0.6.119
v0.6.118
v0.6.117
v0.6.116
v0.6.115
v0.6.114
v0.6.113
v0.6.112
v0.6.111
v0.6.110
v0.6.109
v0.6.108
v0.6.107
v0.6.106
v0.6.105
v0.6.104
v0.6.103
v0.6.102
v0.6.101
v0.6.100
v0.6.99
v0.6.98
v0.6.97
v0.6.96
v0.6.95
v0.6.94
v0.6.93
v0.6.92
v0.6.91
v0.6.90
v0.6.89
v0.6.88
v0.6.87
v0.6.86
v0.6.85
v0.6.84
v0.6.83
v0.6.82
v0.6.81
v0.6.80
v0.6.79
v0.6.78
v0.6.77
v0.6.76
v0.6.75
v0.6.74
v0.6.73
v0.6.72
v0.6.71
v0.6.70
v0.6.69
v0.6.68
v0.6.67
v0.6.66
v0.6.65
v0.6.64
v0.6.63
v0.6.62
v0.6.61
v0.6.60
v0.6.59
v0.6.58
v0.6.57
v0.6.56
v0.6.55
v0.6.54
v0.6.53
v0.6.52
v0.6.51
v0.6.50
v0.6.49
v0.6.48
v0.6.47
v0.6.46
v0.6.45
v0.6.44
v0.6.43
v0.6.42
v0.6.41
v0.6.40
v0.6.39
v0.6.38
v0.6.37
v0.6.36
v0.6.35
v0.6.34
v0.6.33
v0.6.32
v0.6.31
v0.6.30
v0.6.29
v0.6.28
v0.6.25
v0.6.24
v0.6.23
v0.6.22
v0.6.21
v0.6.20
v0.6.19
v0.6.18
v0.6.17
v0.6.16
v0.6.15
v0.6.14
v0.6.12
v0.6.11
v0.6.10
v0.6.9
v0.6.8
v0.6.7
v0.6.6
v0.6.5
v0.6.4
v0.6.3
v0.6.2
v0.6.1
v0.6.0
v0.5.7
v0.5.6
v0.5.5
v0.5.4
v0.5.3
v0.5.2
v0.5.1
v0.5.0
v0.4.12
v0.4.11
v0.4.10
v0.4.9
v0.4.8
v0.4.7
v0.4.6
v0.4.5
v0.4.4
v0.4.3
v0.4.2
v0.4.1
v0.3.30
v0.3.29
v0.3.28
v0.3.27
v0.3.26
v0.3.25
v0.3.24
v0.3.23
v0.3.22
v0.3.21
v0.3.20
v0.3.19
v0.3.18
v0.3.17
v0.3.16
v0.3.15
v0.3.14
v0.3.13
v0.3.12
v0.3.11
v0.3.10
v0.3.9
v0.3.8
v0.3.7
v0.3.6
v0.3.5
v0.3.4
v0.3.3
v0.3.2
v0.3.1
v0.3.0
v0.2.7
v0.2.6
v0.2.5
v0.2.4
v0.2.3
v0.2.2
v0.2.1
v0.2.0
v0.0.3
v0.0.2
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".
No due date set.
Dependencies
No dependencies set.
Reference: Cordy/Cairn#1108
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Gap (v0.7 feature-gap research, 2026-11-04, decided by Nikola). Since #890 the admin API accepts browser sessions only, so creating accounts, spaces, quotas or shares cannot be scripted, and there is no published API reference.
Competitors. Nextcloud and ownCloud 10 have
occplus the provisioning API; OpenCloud has the LibreGraph API with app tokens (auth-app, graph); Seafile has the admin web API with tokens.To research and decide when worked on (must respect #890's reasons). A scoped, expiring, audited admin credential (which scopes, where it is created, IP binding, how it is revoked, never usable from a browser) vs a
cairnd adminCLI that talks to the state store; which routes are covered; the reference format (OpenAPI generated from the code); rate limits; multi-instance (#742).Refs:
scratch/b7e/backlog/gap-v07/research-v07-gaps.mdA15, #890.Research done (
scratch/b7e/backlog/research-1108.md). Today every admin power needs a browser session (auth.AdminPowers, 147requireAdminroutes, #890); #890 itself named "a scoped, revocable admin API token" as the follow-up. Nextcloud 34 reached the same conclusion as #890 (app passwords not for management APIs, CVE-2026-77172) but shipped no replacement; Google, Microsoft, GitLab, Forgejo and GitHub use a separate machine credential with named scopes, expiry and review. Incidents (CircleCI, Okta, Cloudflare, Midnight Blizzard, tj-actions) argue for scoped, expiring, audited, revocable keys that cannot escalate. Recommended: native "API keys" (admin-created from a confirmed browser session, shown once, hashed, prefixed for secret scanning, scopes read/change per area, required expiry, optional address list, Bearer only, its own audited actor, off by default) that can never reach file content, settings, admin roles, keys, purge or holds; OpenAPI 3.1 reference for the reachable routes; IdP client credentials and SCIM later. Decisions follow.Decided by Nikola 2026-11-10: native API keys (admin-created from a confirmed browser session, shown once, hashed, prefixed for secret scanners, scopes per area read/change, expiry required default 90 d max 365, optional address list, Bearer only, its own audited actor with the creator recorded, off by default; never file content, settings, admin roles, encryption keys, purge, holds or other keys). Also: no deleting spaces/accounts in v1; keys unused 90 days stop with notice; instance policy can require address lists; local password reset under the accounts scope (shown once, audited, announced); OpenAPI 3.1 reference kept honest by a route test; 20 req/s burst 100 per key, 429 + Retry-After; SCIM a v1.x follow-up; creating/rotating a key needs the creator's second factor once #1046 ships. Next: mockup.
Mockup
1108-api-keys-mockup.htmlapproved by Nikola 2026-11-10 with its open points as recommended (key names by the username rule without "@", no renaming; config-file emergency accounts cannot create keys; a Read level for every area; no deleting app groups by key; rotation restarts the original expiry length, revoked never rotates; the confirm dialog fetches the key challenge on open; admins without a second step may create keys with a nudge and an Admin review flag; address-list keys fail closed when real client addresses are not visible; refusal bell first per key per 24 h; Admin review flags; tab between Groups and Seats). Change: docs stay in the repo only (handbook pagedocs/handbook/automation-api.md,openapi.yamlin the repo and served by the instance), nothing published on swisscairn.ch now. Next: spec and plan (b6v07, v0.6.406).Spec decisions (2026-11-10), after research on the spec's open points:
api:, so audit actors are never ambiguous.Sec-Fetch-Modealone, because Node's fetch sends it on every request.Next: spec and plan updated, then build (b6v07).
Shipped in v0.6.406 (PR #1157, merge
bee68e7c). Live on both dogfoods since 2026-11-11 15:34 UTC: pods ready with no restarts, no new WARN or ERROR lines./api/v1/openapi.yamlanswers 401 without a sign-in, and a junk Bearer key gets 401.What shipped
cairn_ak_…), off by default. An administrator creates them in Users & access › API keys after Confirm it's you, with the second step when they have one. A key is shown once and stored as SHA-256. Each key has scopes (read or change per area), an expiry (90 days by default, 365 at most) and an optional address list.Sec-Fetch-Modealone), paused after a restore, address, key management, files, scope, then a rate limit of 20/s with a burst of 100.admins.json, app groups, directory admin groups). That covers create, reset, disable, rename, e-mail, devices and personal quota. If group membership cannot be checked, the key is refused.lh:hashes instead), the audit folder, or the storage location.api:<name>with the creator recorded. It holds no licence seat and makes no home folder. Keys stop after 90 days without use, and pause after a storage restore until rotated.docs/handbook/automation-api.md(in the repo only, per the docs rule). Also bell items, Admin review, export rows and audit verbs.Follow-ups: SCIM 2.0 server and IdP client credentials (phase 2) are filed separately. The backlog holds Keycloak admin groups with more than 500 members, an administrator group's group quota, and an LDAP outage blocking keys for local accounts.