@productcraft/auth 1.0.0 → 1.1.0
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/README.md +33 -2
- package/api.md +547 -230
- package/dist/index.cjs +868 -231
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +37246 -0
- package/dist/index.d.ts +1058 -263
- package/dist/index.js +868 -231
- package/dist/index.js.map +1 -1
- package/dist/testing.d.cts +32 -0
- package/manifest.json +210 -210
- package/package.json +25 -8
package/manifest.json
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"resource": "apiKeys",
|
|
14
14
|
"scope": "app",
|
|
15
15
|
"signature": "auth.admin.app(…).apiKeys.create(params, options?): Auth.CreateApiKey",
|
|
16
|
-
"snippet": "const createApiKey = await auth.admin.app(\"
|
|
16
|
+
"snippet": "const createApiKey = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").apiKeys.create({ name: \"CI deploy bot\", permissions: [\"user.read\", \"user.list\"] });"
|
|
17
17
|
},
|
|
18
18
|
"ApiKeyController_deleteApiKey": {
|
|
19
19
|
"actor": null,
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"resource": "apiKeys",
|
|
29
29
|
"scope": "app",
|
|
30
30
|
"signature": "auth.admin.app(…).apiKeys.delete(keyId, options?): void",
|
|
31
|
-
"snippet": "await auth.admin.app(\"
|
|
31
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").apiKeys.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
32
32
|
},
|
|
33
33
|
"ApiKeyController_listApiKeys": {
|
|
34
34
|
"actor": null,
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"resource": "apiKeys",
|
|
44
44
|
"scope": "app",
|
|
45
45
|
"signature": "auth.admin.app(…).apiKeys.list(params?, options?): PagePromise<Auth.ApiKeySummary>",
|
|
46
|
-
"snippet": "for await (const apiKey of auth.admin.app(\"
|
|
46
|
+
"snippet": "for await (const apiKey of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").apiKeys.list()) {\n console.log(apiKey);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").apiKeys.list({}, { timeout: 5_000 });"
|
|
47
47
|
},
|
|
48
48
|
"ApiKeyController_rotateApiKey": {
|
|
49
49
|
"actor": null,
|
|
@@ -58,7 +58,7 @@
|
|
|
58
58
|
"resource": "apiKeys",
|
|
59
59
|
"scope": "app",
|
|
60
60
|
"signature": "auth.admin.app(…).apiKeys.rotate(keyId, params?, options?): Auth.RotateApiKey",
|
|
61
|
-
"snippet": "const rotateApiKey = await auth.admin.app(\"
|
|
61
|
+
"snippet": "const rotateApiKey = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").apiKeys.rotate(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { grace_hours: 24 });"
|
|
62
62
|
},
|
|
63
63
|
"AppAuditController_exportAuditLogs": {
|
|
64
64
|
"actor": "query",
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
"resource": "auditLogs",
|
|
74
74
|
"scope": "app",
|
|
75
75
|
"signature": "auth.admin.app(…).auditLogs.export(params?, options?): Response",
|
|
76
|
-
"snippet": "const response = await auth.admin.app(\"
|
|
76
|
+
"snippet": "const response = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").auditLogs.export();\nconst text = await response.text();"
|
|
77
77
|
},
|
|
78
78
|
"AppAuditController_getAuditLogs": {
|
|
79
79
|
"actor": "query",
|
|
@@ -88,7 +88,7 @@
|
|
|
88
88
|
"resource": "auditLogs",
|
|
89
89
|
"scope": "app",
|
|
90
90
|
"signature": "auth.admin.app(…).auditLogs.list(params?, options?): PagePromise<Auth.AuditLogEntry>",
|
|
91
|
-
"snippet": "for await (const auditLog of auth.admin.app(\"
|
|
91
|
+
"snippet": "for await (const auditLog of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").auditLogs.list()) {\n console.log(auditLog);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").auditLogs.list({}, { timeout: 5_000 });"
|
|
92
92
|
},
|
|
93
93
|
"AppAuditSinkController_get": {
|
|
94
94
|
"actor": null,
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
"resource": "auditSink",
|
|
104
104
|
"scope": "app",
|
|
105
105
|
"signature": "auth.admin.app(…).auditSink.retrieve(options?): Auth.AuditSink",
|
|
106
|
-
"snippet": "const auditSink = await auth.admin.app(\"
|
|
106
|
+
"snippet": "const auditSink = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").auditSink.retrieve();"
|
|
107
107
|
},
|
|
108
108
|
"AppAuditSinkController_remove": {
|
|
109
109
|
"actor": null,
|
|
@@ -118,7 +118,7 @@
|
|
|
118
118
|
"resource": "auditSink",
|
|
119
119
|
"scope": "app",
|
|
120
120
|
"signature": "auth.admin.app(…).auditSink.disconnect(options?): void",
|
|
121
|
-
"snippet": "await auth.admin.app(\"
|
|
121
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").auditSink.disconnect();"
|
|
122
122
|
},
|
|
123
123
|
"AppAuditSinkController_rotateSecret": {
|
|
124
124
|
"actor": null,
|
|
@@ -133,7 +133,7 @@
|
|
|
133
133
|
"resource": "auditSink",
|
|
134
134
|
"scope": "app",
|
|
135
135
|
"signature": "auth.admin.app(…).auditSink.rotateSecret(options?): Auth.AuditSinkWithSecret",
|
|
136
|
-
"snippet": "const auditSinkWithSecret = await auth.admin.app(\"
|
|
136
|
+
"snippet": "const auditSinkWithSecret = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").auditSink.rotateSecret();"
|
|
137
137
|
},
|
|
138
138
|
"AppAuditSinkController_sendTest": {
|
|
139
139
|
"actor": null,
|
|
@@ -148,7 +148,7 @@
|
|
|
148
148
|
"resource": "auditSink",
|
|
149
149
|
"scope": "app",
|
|
150
150
|
"signature": "auth.admin.app(…).auditSink.test(options?): Auth.AuditSinkTestResult",
|
|
151
|
-
"snippet": "const auditSinkTestResult = await auth.admin.app(\"
|
|
151
|
+
"snippet": "const auditSinkTestResult = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").auditSink.test();"
|
|
152
152
|
},
|
|
153
153
|
"AppAuditSinkController_setupStatus": {
|
|
154
154
|
"actor": null,
|
|
@@ -163,7 +163,7 @@
|
|
|
163
163
|
"resource": "auditSink",
|
|
164
164
|
"scope": "app",
|
|
165
165
|
"signature": "auth.admin.app(…).auditSink.setupStatus(options?): Auth.SetupStatus",
|
|
166
|
-
"snippet": "const setupStatus = await auth.admin.app(\"
|
|
166
|
+
"snippet": "const setupStatus = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").auditSink.setupStatus();"
|
|
167
167
|
},
|
|
168
168
|
"AppAuditSinkController_update": {
|
|
169
169
|
"actor": null,
|
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
"resource": "auditSink",
|
|
179
179
|
"scope": "app",
|
|
180
180
|
"signature": "auth.admin.app(…).auditSink.update(params?, options?): Auth.AuditSink",
|
|
181
|
-
"snippet": "const auditSink = await auth.admin.app(\"
|
|
181
|
+
"snippet": "const auditSink = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").auditSink.update({ enabled: true });"
|
|
182
182
|
},
|
|
183
183
|
"AppAuditSinkController_upsert": {
|
|
184
184
|
"actor": null,
|
|
@@ -193,7 +193,7 @@
|
|
|
193
193
|
"resource": "auditSink",
|
|
194
194
|
"scope": "app",
|
|
195
195
|
"signature": "auth.admin.app(…).auditSink.replace(params, options?): Auth.AuditSinkWithSecret",
|
|
196
|
-
"snippet": "const auditSinkWithSecret = await auth.admin.app(\"
|
|
196
|
+
"snippet": "const auditSinkWithSecret = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").auditSink.replace({ url: \"https://siem.customer.example.com/ingest/productcraft-auth\" });"
|
|
197
197
|
},
|
|
198
198
|
"AppController_cloneApp": {
|
|
199
199
|
"actor": null,
|
|
@@ -208,7 +208,7 @@
|
|
|
208
208
|
"resource": "",
|
|
209
209
|
"scope": "app",
|
|
210
210
|
"signature": "auth.admin.app(…).clone(params, options?): Auth.CloneApp",
|
|
211
|
-
"snippet": "const cloneApp = await auth.admin.app(\"
|
|
211
|
+
"snippet": "const cloneApp = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").clone({ environment: \"staging\", slug: \"acme-app-staging\" });"
|
|
212
212
|
},
|
|
213
213
|
"AppController_createApp": {
|
|
214
214
|
"actor": null,
|
|
@@ -238,7 +238,7 @@
|
|
|
238
238
|
"resource": "apps",
|
|
239
239
|
"scope": null,
|
|
240
240
|
"signature": "auth.apps.delete(appId, options?): void",
|
|
241
|
-
"snippet": "await auth.apps.delete(\"
|
|
241
|
+
"snippet": "await auth.apps.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
242
242
|
},
|
|
243
243
|
"AppController_getApp": {
|
|
244
244
|
"actor": null,
|
|
@@ -253,7 +253,7 @@
|
|
|
253
253
|
"resource": "apps",
|
|
254
254
|
"scope": null,
|
|
255
255
|
"signature": "auth.apps.retrieve(appId, options?): Auth.App",
|
|
256
|
-
"snippet": "const app = await auth.apps.retrieve(\"
|
|
256
|
+
"snippet": "const app = await auth.apps.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
257
257
|
},
|
|
258
258
|
"AppController_listMembers": {
|
|
259
259
|
"actor": null,
|
|
@@ -268,7 +268,7 @@
|
|
|
268
268
|
"resource": "members",
|
|
269
269
|
"scope": "app",
|
|
270
270
|
"signature": "auth.admin.app(…).members.list(params?, options?): PagePromise<Auth.AppMemberSummary>",
|
|
271
|
-
"snippet": "for await (const member of auth.admin.app(\"
|
|
271
|
+
"snippet": "for await (const member of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").members.list()) {\n console.log(member);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").members.list({}, { timeout: 5_000 });"
|
|
272
272
|
},
|
|
273
273
|
"AppController_listMyApps": {
|
|
274
274
|
"actor": null,
|
|
@@ -298,7 +298,7 @@
|
|
|
298
298
|
"resource": "members",
|
|
299
299
|
"scope": "app",
|
|
300
300
|
"signature": "auth.admin.app(…).members.delete(accountId, options?): void",
|
|
301
|
-
"snippet": "await auth.admin.app(\"
|
|
301
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").members.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
302
302
|
},
|
|
303
303
|
"AppController_updateApp": {
|
|
304
304
|
"actor": null,
|
|
@@ -313,7 +313,7 @@
|
|
|
313
313
|
"resource": "apps",
|
|
314
314
|
"scope": null,
|
|
315
315
|
"signature": "auth.apps.update(appId, params?, options?): Auth.App",
|
|
316
|
-
"snippet": "const app = await auth.apps.update(\"
|
|
316
|
+
"snippet": "const app = await auth.apps.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { audit_retention_days: 365 });"
|
|
317
317
|
},
|
|
318
318
|
"AppController_updateAppStatus": {
|
|
319
319
|
"actor": null,
|
|
@@ -328,7 +328,7 @@
|
|
|
328
328
|
"resource": "",
|
|
329
329
|
"scope": "app",
|
|
330
330
|
"signature": "auth.admin.app(…).updateStatus(params, options?): Auth.App",
|
|
331
|
-
"snippet": "const app = await auth.admin.app(\"
|
|
331
|
+
"snippet": "const app = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").updateStatus({ status: \"suspended\" });"
|
|
332
332
|
},
|
|
333
333
|
"AppTenantApiKeysController_getConfig": {
|
|
334
334
|
"actor": null,
|
|
@@ -343,7 +343,7 @@
|
|
|
343
343
|
"resource": "tenantApiKeys.config",
|
|
344
344
|
"scope": "consumer",
|
|
345
345
|
"signature": "auth.consumer(…).tenantApiKeys.config.retrieve(options?): Auth.TenantApiKeysConfig",
|
|
346
|
-
"snippet": "const tenantApiKeysConfig = await auth.consumer(\"app\").tenantApiKeys.config.retrieve();"
|
|
346
|
+
"snippet": "const tenantApiKeysConfig = await auth.consumer(\"my-app\").tenantApiKeys.config.retrieve();"
|
|
347
347
|
},
|
|
348
348
|
"AppTenantApiKeysController_introspect": {
|
|
349
349
|
"actor": null,
|
|
@@ -358,7 +358,7 @@
|
|
|
358
358
|
"resource": "tenantApiKeys",
|
|
359
359
|
"scope": "consumer",
|
|
360
360
|
"signature": "auth.consumer(…).tenantApiKeys.introspect(params, options?): Auth.TenantApiKeyIntrospection",
|
|
361
|
-
"snippet": "const tenantApiKeyIntrospection = await auth.consumer(\"app\").tenantApiKeys.introspect({ key: \"pctk_live_4fQ2aZ0000000000000000000000000000000000000_1a2B3c\" });"
|
|
361
|
+
"snippet": "const tenantApiKeyIntrospection = await auth.consumer(\"my-app\").tenantApiKeys.introspect({ key: \"pctk_live_4fQ2aZ0000000000000000000000000000000000000_1a2B3c\" });"
|
|
362
362
|
},
|
|
363
363
|
"AppTenantApiKeysController_putConfig": {
|
|
364
364
|
"actor": null,
|
|
@@ -373,7 +373,7 @@
|
|
|
373
373
|
"resource": "tenantApiKeys.config",
|
|
374
374
|
"scope": "consumer",
|
|
375
375
|
"signature": "auth.consumer(…).tenantApiKeys.config.update(params?, options?): Auth.TenantApiKeysConfig",
|
|
376
|
-
"snippet": "const tenantApiKeysConfig = await auth.consumer(\"app\").tenantApiKeys.config.update({ default_expiry_days: 7 });"
|
|
376
|
+
"snippet": "const tenantApiKeysConfig = await auth.consumer(\"my-app\").tenantApiKeys.config.update({ default_expiry_days: 7 });"
|
|
377
377
|
},
|
|
378
378
|
"AppTenantApiKeysController_status": {
|
|
379
379
|
"actor": null,
|
|
@@ -388,7 +388,7 @@
|
|
|
388
388
|
"resource": "tenantApiKeys",
|
|
389
389
|
"scope": "consumer",
|
|
390
390
|
"signature": "auth.consumer(…).tenantApiKeys.status(keyId, options?): Auth.TenantApiKeyStatus",
|
|
391
|
-
"snippet": "const tenantApiKeyStatus = await auth.consumer(\"app\").tenantApiKeys.status(\"
|
|
391
|
+
"snippet": "const tenantApiKeyStatus = await auth.consumer(\"my-app\").tenantApiKeys.status(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
392
392
|
},
|
|
393
393
|
"AuthConfigController_getConfig": {
|
|
394
394
|
"actor": null,
|
|
@@ -403,7 +403,7 @@
|
|
|
403
403
|
"resource": "authConfig",
|
|
404
404
|
"scope": "app",
|
|
405
405
|
"signature": "auth.admin.app(…).authConfig.retrieve(options?): Auth.AuthConfig",
|
|
406
|
-
"snippet": "const authConfig = await auth.admin.app(\"
|
|
406
|
+
"snippet": "const authConfig = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").authConfig.retrieve();"
|
|
407
407
|
},
|
|
408
408
|
"AuthConfigController_updateConfig": {
|
|
409
409
|
"actor": null,
|
|
@@ -418,7 +418,7 @@
|
|
|
418
418
|
"resource": "authConfig",
|
|
419
419
|
"scope": "app",
|
|
420
420
|
"signature": "auth.admin.app(…).authConfig.update(params?, options?): Auth.AuthConfig",
|
|
421
|
-
"snippet": "const authConfig = await auth.admin.app(\"
|
|
421
|
+
"snippet": "const authConfig = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").authConfig.update({ access_token_minutes: 60 });"
|
|
422
422
|
},
|
|
423
423
|
"AuthConfigProviderController_check": {
|
|
424
424
|
"actor": null,
|
|
@@ -433,7 +433,7 @@
|
|
|
433
433
|
"resource": "authConfig.providers",
|
|
434
434
|
"scope": "app",
|
|
435
435
|
"signature": "auth.admin.app(…).authConfig.providers.check(provider, options?): Auth.ProviderCheck",
|
|
436
|
-
"snippet": "const providerCheck = await auth.admin.app(\"
|
|
436
|
+
"snippet": "const providerCheck = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").authConfig.providers.check(\"google\");"
|
|
437
437
|
},
|
|
438
438
|
"AuthConfigProviderController_delete": {
|
|
439
439
|
"actor": null,
|
|
@@ -448,7 +448,7 @@
|
|
|
448
448
|
"resource": "authConfig.providers",
|
|
449
449
|
"scope": "app",
|
|
450
450
|
"signature": "auth.admin.app(…).authConfig.providers.delete(provider, options?): void",
|
|
451
|
-
"snippet": "await auth.admin.app(\"
|
|
451
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").authConfig.providers.delete(\"google\");"
|
|
452
452
|
},
|
|
453
453
|
"AuthConfigProviderController_get": {
|
|
454
454
|
"actor": null,
|
|
@@ -463,7 +463,7 @@
|
|
|
463
463
|
"resource": "authConfig.providers",
|
|
464
464
|
"scope": "app",
|
|
465
465
|
"signature": "auth.admin.app(…).authConfig.providers.retrieve(provider, options?): Auth.ProviderDetail",
|
|
466
|
-
"snippet": "const providerDetail = await auth.admin.app(\"
|
|
466
|
+
"snippet": "const providerDetail = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").authConfig.providers.retrieve(\"google\");"
|
|
467
467
|
},
|
|
468
468
|
"AuthConfigProviderController_list": {
|
|
469
469
|
"actor": null,
|
|
@@ -478,7 +478,7 @@
|
|
|
478
478
|
"resource": "authConfig.providers",
|
|
479
479
|
"scope": "app",
|
|
480
480
|
"signature": "auth.admin.app(…).authConfig.providers.list(options?): Auth.AuthConfigProviderListResponse",
|
|
481
|
-
"snippet": "const result = await auth.admin.app(\"
|
|
481
|
+
"snippet": "const result = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").authConfig.providers.list();"
|
|
482
482
|
},
|
|
483
483
|
"AuthConfigProviderController_patch": {
|
|
484
484
|
"actor": null,
|
|
@@ -493,7 +493,7 @@
|
|
|
493
493
|
"resource": "authConfig.providers",
|
|
494
494
|
"scope": "app",
|
|
495
495
|
"signature": "auth.admin.app(…).authConfig.providers.update(provider, params?, options?): Auth.ProviderDetail",
|
|
496
|
-
"snippet": "const providerDetail = await auth.admin.app(\"
|
|
496
|
+
"snippet": "const providerDetail = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").authConfig.providers.update(\"google\", { config: {} });"
|
|
497
497
|
},
|
|
498
498
|
"AuthConfigProviderController_upsert": {
|
|
499
499
|
"actor": null,
|
|
@@ -508,7 +508,7 @@
|
|
|
508
508
|
"resource": "authConfig.providers",
|
|
509
509
|
"scope": "app",
|
|
510
510
|
"signature": "auth.admin.app(…).authConfig.providers.replace(provider, params, options?): Auth.ProviderDetail",
|
|
511
|
-
"snippet": "const providerDetail = await auth.admin.app(\"
|
|
511
|
+
"snippet": "const providerDetail = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").authConfig.providers.replace(\"google\", { config: {} });"
|
|
512
512
|
},
|
|
513
513
|
"ConsumerAdminController_createUser": {
|
|
514
514
|
"actor": null,
|
|
@@ -523,7 +523,7 @@
|
|
|
523
523
|
"resource": "users",
|
|
524
524
|
"scope": "consumer",
|
|
525
525
|
"signature": "auth.consumer(…).users.create(params, options?): Auth.ConsumerAdminCreatedUser",
|
|
526
|
-
"snippet": "const consumerAdminCreatedUser = await auth.consumer(\"app\").users.create({ email: \"
|
|
526
|
+
"snippet": "const consumerAdminCreatedUser = await auth.consumer(\"my-app\").users.create({ email: \"ada@example.com\" });"
|
|
527
527
|
},
|
|
528
528
|
"ConsumerAdminController_deleteUser": {
|
|
529
529
|
"actor": null,
|
|
@@ -538,7 +538,7 @@
|
|
|
538
538
|
"resource": "users",
|
|
539
539
|
"scope": "consumer",
|
|
540
540
|
"signature": "auth.consumer(…).users.delete(userId, options?): void",
|
|
541
|
-
"snippet": "await auth.consumer(\"app\").users.delete(\"
|
|
541
|
+
"snippet": "await auth.consumer(\"my-app\").users.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
542
542
|
},
|
|
543
543
|
"ConsumerAdminController_getUser": {
|
|
544
544
|
"actor": null,
|
|
@@ -553,7 +553,7 @@
|
|
|
553
553
|
"resource": "users",
|
|
554
554
|
"scope": "consumer",
|
|
555
555
|
"signature": "auth.consumer(…).users.retrieve(userId, options?): Auth.ConsumerAdminEndUser",
|
|
556
|
-
"snippet": "const consumerAdminEndUser = await auth.consumer(\"app\").users.retrieve(\"
|
|
556
|
+
"snippet": "const consumerAdminEndUser = await auth.consumer(\"my-app\").users.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
557
557
|
},
|
|
558
558
|
"ConsumerAdminController_listUsers": {
|
|
559
559
|
"actor": null,
|
|
@@ -568,7 +568,7 @@
|
|
|
568
568
|
"resource": "users",
|
|
569
569
|
"scope": "consumer",
|
|
570
570
|
"signature": "auth.consumer(…).users.list(params?, options?): PagePromise<Auth.ConsumerAdminEndUser>",
|
|
571
|
-
"snippet": "for await (const user of auth.consumer(\"app\").users.list()) {\n console.log(user);\n}\nconst page = await auth.consumer(\"app\").users.list({}, { timeout: 5_000 });"
|
|
571
|
+
"snippet": "for await (const user of auth.consumer(\"my-app\").users.list()) {\n console.log(user);\n}\nconst page = await auth.consumer(\"my-app\").users.list({}, { timeout: 5_000 });"
|
|
572
572
|
},
|
|
573
573
|
"ConsumerAdminController_updateRole": {
|
|
574
574
|
"actor": null,
|
|
@@ -583,7 +583,7 @@
|
|
|
583
583
|
"resource": "users",
|
|
584
584
|
"scope": "consumer",
|
|
585
585
|
"signature": "auth.consumer(…).users.updateRole(userId, params, options?): Auth.ConsumerAdminRoleAssignment",
|
|
586
|
-
"snippet": "const consumerAdminRoleAssignment = await auth.consumer(\"app\").users.updateRole(\"
|
|
586
|
+
"snippet": "const consumerAdminRoleAssignment = await auth.consumer(\"my-app\").users.updateRole(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { role_name: \"member\" });"
|
|
587
587
|
},
|
|
588
588
|
"ConsumerAdminController_updateStatus": {
|
|
589
589
|
"actor": null,
|
|
@@ -598,7 +598,7 @@
|
|
|
598
598
|
"resource": "users",
|
|
599
599
|
"scope": "consumer",
|
|
600
600
|
"signature": "auth.consumer(…).users.updateStatus(userId, params, options?): Auth.ConsumerAdminEndUser",
|
|
601
|
-
"snippet": "const consumerAdminEndUser = await auth.consumer(\"app\").users.updateStatus(\"
|
|
601
|
+
"snippet": "const consumerAdminEndUser = await auth.consumer(\"my-app\").users.updateStatus(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { status: \"active\" });"
|
|
602
602
|
},
|
|
603
603
|
"ConsumerAdminController_updateUser": {
|
|
604
604
|
"actor": null,
|
|
@@ -613,7 +613,7 @@
|
|
|
613
613
|
"resource": "users",
|
|
614
614
|
"scope": "consumer",
|
|
615
615
|
"signature": "auth.consumer(…).users.update(userId, params?, options?): Auth.ConsumerAdminEndUser",
|
|
616
|
-
"snippet": "const consumerAdminEndUser = await auth.consumer(\"app\").users.update(\"
|
|
616
|
+
"snippet": "const consumerAdminEndUser = await auth.consumer(\"my-app\").users.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { display_name: \"Ada Lovelace\" });"
|
|
617
617
|
},
|
|
618
618
|
"ConsumerAdminFactorsController_disable": {
|
|
619
619
|
"actor": null,
|
|
@@ -628,7 +628,7 @@
|
|
|
628
628
|
"resource": "users.factors",
|
|
629
629
|
"scope": "consumer",
|
|
630
630
|
"signature": "auth.consumer(…).users.factors.delete(userId, factorId, options?): void",
|
|
631
|
-
"snippet": "await auth.consumer(\"app\").users.factors.delete(\"
|
|
631
|
+
"snippet": "await auth.consumer(\"my-app\").users.factors.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
632
632
|
},
|
|
633
633
|
"ConsumerAdminFactorsController_list": {
|
|
634
634
|
"actor": null,
|
|
@@ -643,7 +643,7 @@
|
|
|
643
643
|
"resource": "users.factors",
|
|
644
644
|
"scope": "consumer",
|
|
645
645
|
"signature": "auth.consumer(…).users.factors.list(userId, options?): Auth.FactorList",
|
|
646
|
-
"snippet": "const factorList = await auth.consumer(\"app\").users.factors.list(\"
|
|
646
|
+
"snippet": "const factorList = await auth.consumer(\"my-app\").users.factors.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
647
647
|
},
|
|
648
648
|
"ConsumerAdminFactorsController_provision": {
|
|
649
649
|
"actor": null,
|
|
@@ -658,7 +658,7 @@
|
|
|
658
658
|
"resource": "users.factors",
|
|
659
659
|
"scope": "consumer",
|
|
660
660
|
"signature": "auth.consumer(…).users.factors.create(userId, params, options?): Auth.AdminProvisionFactor",
|
|
661
|
-
"snippet": "const adminProvisionFactor = await auth.consumer(\"app\").users.factors.create(\"
|
|
661
|
+
"snippet": "const adminProvisionFactor = await auth.consumer(\"my-app\").users.factors.create(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { type: \"totp\" });"
|
|
662
662
|
},
|
|
663
663
|
"ConsumerAdminPermissionsController_createPermission": {
|
|
664
664
|
"actor": null,
|
|
@@ -673,7 +673,7 @@
|
|
|
673
673
|
"resource": "permissions",
|
|
674
674
|
"scope": "consumer",
|
|
675
675
|
"signature": "auth.consumer(…).permissions.create(params, options?): Auth.ConsumerAdminPermission",
|
|
676
|
-
"snippet": "const consumerAdminPermission = await auth.consumer(\"app\").permissions.create({ action: \"read\", resource: \"project\" });"
|
|
676
|
+
"snippet": "const consumerAdminPermission = await auth.consumer(\"my-app\").permissions.create({ action: \"read\", resource: \"project\" });"
|
|
677
677
|
},
|
|
678
678
|
"ConsumerAdminPermissionsController_deletePermission": {
|
|
679
679
|
"actor": null,
|
|
@@ -688,7 +688,7 @@
|
|
|
688
688
|
"resource": "permissions",
|
|
689
689
|
"scope": "consumer",
|
|
690
690
|
"signature": "auth.consumer(…).permissions.delete(permissionKey, options?): void",
|
|
691
|
-
"snippet": "await auth.consumer(\"app\").permissions.delete(\"
|
|
691
|
+
"snippet": "await auth.consumer(\"my-app\").permissions.delete(\"invoice.read\");"
|
|
692
692
|
},
|
|
693
693
|
"ConsumerAdminPermissionsController_listPermissions": {
|
|
694
694
|
"actor": null,
|
|
@@ -703,7 +703,7 @@
|
|
|
703
703
|
"resource": "permissions",
|
|
704
704
|
"scope": "consumer",
|
|
705
705
|
"signature": "auth.consumer(…).permissions.list(options?): Auth.ConsumerScopedPermissionListResponse",
|
|
706
|
-
"snippet": "const result = await auth.consumer(\"app\").permissions.list();"
|
|
706
|
+
"snippet": "const result = await auth.consumer(\"my-app\").permissions.list();"
|
|
707
707
|
},
|
|
708
708
|
"ConsumerAdminRolesController_createRole": {
|
|
709
709
|
"actor": null,
|
|
@@ -718,7 +718,7 @@
|
|
|
718
718
|
"resource": "roles",
|
|
719
719
|
"scope": "consumer",
|
|
720
720
|
"signature": "auth.consumer(…).roles.create(params, options?): Auth.ConsumerRole",
|
|
721
|
-
"snippet": "const consumerRole = await auth.consumer(\"app\").roles.create({ name: \"editor\" });"
|
|
721
|
+
"snippet": "const consumerRole = await auth.consumer(\"my-app\").roles.create({ name: \"editor\" });"
|
|
722
722
|
},
|
|
723
723
|
"ConsumerAdminRolesController_deleteRole": {
|
|
724
724
|
"actor": null,
|
|
@@ -733,7 +733,7 @@
|
|
|
733
733
|
"resource": "roles",
|
|
734
734
|
"scope": "consumer",
|
|
735
735
|
"signature": "auth.consumer(…).roles.delete(roleName, options?): void",
|
|
736
|
-
"snippet": "await auth.consumer(\"app\").roles.delete(\"
|
|
736
|
+
"snippet": "await auth.consumer(\"my-app\").roles.delete(\"admin\");"
|
|
737
737
|
},
|
|
738
738
|
"ConsumerAdminRolesController_getRole": {
|
|
739
739
|
"actor": null,
|
|
@@ -748,7 +748,7 @@
|
|
|
748
748
|
"resource": "roles",
|
|
749
749
|
"scope": "consumer",
|
|
750
750
|
"signature": "auth.consumer(…).roles.retrieve(roleName, options?): Auth.ConsumerRoleWithPermissions",
|
|
751
|
-
"snippet": "const consumerRoleWithPermissions = await auth.consumer(\"app\").roles.retrieve(\"
|
|
751
|
+
"snippet": "const consumerRoleWithPermissions = await auth.consumer(\"my-app\").roles.retrieve(\"admin\");"
|
|
752
752
|
},
|
|
753
753
|
"ConsumerAdminRolesController_listRoles": {
|
|
754
754
|
"actor": null,
|
|
@@ -763,7 +763,7 @@
|
|
|
763
763
|
"resource": "roles",
|
|
764
764
|
"scope": "consumer",
|
|
765
765
|
"signature": "auth.consumer(…).roles.list(params?, options?): PagePromise<Auth.ConsumerRole>",
|
|
766
|
-
"snippet": "for await (const role of auth.consumer(\"app\").roles.list()) {\n console.log(role);\n}\nconst page = await auth.consumer(\"app\").roles.list({}, { timeout: 5_000 });"
|
|
766
|
+
"snippet": "for await (const role of auth.consumer(\"my-app\").roles.list()) {\n console.log(role);\n}\nconst page = await auth.consumer(\"my-app\").roles.list({}, { timeout: 5_000 });"
|
|
767
767
|
},
|
|
768
768
|
"ConsumerAdminRolesController_setPermissions": {
|
|
769
769
|
"actor": null,
|
|
@@ -778,7 +778,7 @@
|
|
|
778
778
|
"resource": "roles",
|
|
779
779
|
"scope": "consumer",
|
|
780
780
|
"signature": "auth.consumer(…).roles.updatePermissions(roleName, params, options?): Auth.ConsumerScopedRoleUpdatePermissionsResponse",
|
|
781
|
-
"snippet": "const result = await auth.consumer(\"app\").roles.updatePermissions(\"
|
|
781
|
+
"snippet": "const result = await auth.consumer(\"my-app\").roles.updatePermissions(\"admin\", { permissions: [\"user.read\", \"role.create\"] });"
|
|
782
782
|
},
|
|
783
783
|
"ConsumerAdminRolesController_updateRole": {
|
|
784
784
|
"actor": null,
|
|
@@ -793,7 +793,7 @@
|
|
|
793
793
|
"resource": "roles",
|
|
794
794
|
"scope": "consumer",
|
|
795
795
|
"signature": "auth.consumer(…).roles.update(roleName, params?, options?): Auth.ConsumerRole",
|
|
796
|
-
"snippet": "const consumerRole = await auth.consumer(\"app\").roles.update(\"
|
|
796
|
+
"snippet": "const consumerRole = await auth.consumer(\"my-app\").roles.update(\"admin\", { description: \"Updated description\" });"
|
|
797
797
|
},
|
|
798
798
|
"ConsumerAuthController_acceptInvite": {
|
|
799
799
|
"actor": null,
|
|
@@ -808,7 +808,7 @@
|
|
|
808
808
|
"resource": "",
|
|
809
809
|
"scope": "consumer",
|
|
810
810
|
"signature": "auth.consumer(…).acceptInvite(params, options?): Auth.AcceptInviteResponse",
|
|
811
|
-
"snippet": "const result = await auth.consumer(\"app\").acceptInvite({ code: \"inv_x7H2k3jLqXr\", password: \"CorrectHorseBatteryStaple\" });"
|
|
811
|
+
"snippet": "const result = await auth.consumer(\"my-app\").acceptInvite({ code: \"inv_x7H2k3jLqXr\", password: \"CorrectHorseBatteryStaple\" });"
|
|
812
812
|
},
|
|
813
813
|
"ConsumerAuthController_acceptTenantInvite": {
|
|
814
814
|
"actor": null,
|
|
@@ -823,7 +823,7 @@
|
|
|
823
823
|
"resource": "",
|
|
824
824
|
"scope": "consumer",
|
|
825
825
|
"signature": "auth.consumer(…).acceptTenantInvite(params, options?): Auth.ConsumerToken",
|
|
826
|
-
"snippet": "const consumerToken = await auth.consumer(\"app\").acceptTenantInvite({ code: \"tinv_9dK2mQ7pR4vXbN1sT6yZ0hLcJeW3fAgU\", password: \"CorrectHorseBatteryStaple\" });"
|
|
826
|
+
"snippet": "const consumerToken = await auth.consumer(\"my-app\").acceptTenantInvite({ code: \"tinv_9dK2mQ7pR4vXbN1sT6yZ0hLcJeW3fAgU\", password: \"CorrectHorseBatteryStaple\" });"
|
|
827
827
|
},
|
|
828
828
|
"ConsumerAuthController_listMyTenants": {
|
|
829
829
|
"actor": null,
|
|
@@ -838,7 +838,7 @@
|
|
|
838
838
|
"resource": "me.tenants",
|
|
839
839
|
"scope": "consumer",
|
|
840
840
|
"signature": "auth.consumer(…).me.tenants.list(options?): Auth.MyTenants",
|
|
841
|
-
"snippet": "const myTenants = await auth.consumer(\"app\").me.tenants.list();"
|
|
841
|
+
"snippet": "const myTenants = await auth.consumer(\"my-app\").me.tenants.list();"
|
|
842
842
|
},
|
|
843
843
|
"ConsumerAuthController_logout": {
|
|
844
844
|
"actor": null,
|
|
@@ -853,7 +853,7 @@
|
|
|
853
853
|
"resource": "",
|
|
854
854
|
"scope": "consumer",
|
|
855
855
|
"signature": "auth.consumer(…).logout(params, options?): void",
|
|
856
|
-
"snippet": "await auth.consumer(\"app\").logout({
|
|
856
|
+
"snippet": "await auth.consumer(\"my-app\").logout({\n refresh_token: \"eyJhbGciOiJSUzI1NiIsImtpZCI6ImsxIn0.eyJ0eXAiOiJyZWZyZXNoIn0.c2lnbmF0dXJl\",\n});"
|
|
857
857
|
},
|
|
858
858
|
"ConsumerAuthController_mfaEnroll": {
|
|
859
859
|
"actor": null,
|
|
@@ -868,7 +868,7 @@
|
|
|
868
868
|
"resource": "mfa",
|
|
869
869
|
"scope": "consumer",
|
|
870
870
|
"signature": "auth.consumer(…).mfa.enroll(params, options?): Auth.StartEnrollment",
|
|
871
|
-
"snippet": "const startEnrollment = await auth.consumer(\"app\").mfa.enroll({ mfa_token: \"
|
|
871
|
+
"snippet": "const startEnrollment = await auth.consumer(\"my-app\").mfa.enroll({ mfa_token: \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", type: \"totp\" });"
|
|
872
872
|
},
|
|
873
873
|
"ConsumerAuthController_mfaEnrollVerify": {
|
|
874
874
|
"actor": null,
|
|
@@ -883,7 +883,7 @@
|
|
|
883
883
|
"resource": "mfa",
|
|
884
884
|
"scope": "consumer",
|
|
885
885
|
"signature": "auth.consumer(…).mfa.verifyEnrollment(params, options?): Auth.ConsumerMfaEnrollVerify",
|
|
886
|
-
"snippet": "const consumerMfaEnrollVerify = await auth.consumer(\"app\").mfa.verifyEnrollment({
|
|
886
|
+
"snippet": "const consumerMfaEnrollVerify = await auth.consumer(\"my-app\").mfa.verifyEnrollment({\n factor_id: \"9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b\",\n mfa_token: \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\",\n});"
|
|
887
887
|
},
|
|
888
888
|
"ConsumerAuthController_mfaRecover": {
|
|
889
889
|
"actor": null,
|
|
@@ -898,7 +898,7 @@
|
|
|
898
898
|
"resource": "mfa",
|
|
899
899
|
"scope": "consumer",
|
|
900
900
|
"signature": "auth.consumer(…).mfa.recover(params, options?): Auth.ConsumerToken",
|
|
901
|
-
"snippet": "const consumerToken = await auth.consumer(\"app\").mfa.recover({
|
|
901
|
+
"snippet": "const consumerToken = await auth.consumer(\"my-app\").mfa.recover({\n mfa_token: \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\",\n recovery_code: \"1a2b-3c4d-5e6f-7890\",\n});"
|
|
902
902
|
},
|
|
903
903
|
"ConsumerAuthController_mfaSendCode": {
|
|
904
904
|
"actor": null,
|
|
@@ -913,7 +913,7 @@
|
|
|
913
913
|
"resource": "mfa",
|
|
914
914
|
"scope": "consumer",
|
|
915
915
|
"signature": "auth.consumer(…).mfa.sendCode(params, options?): Auth.ConsumerMfaSendCode",
|
|
916
|
-
"snippet": "const consumerMfaSendCode = await auth.consumer(\"app\").mfa.sendCode({
|
|
916
|
+
"snippet": "const consumerMfaSendCode = await auth.consumer(\"my-app\").mfa.sendCode({\n factor_id: \"9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b\",\n mfa_token: \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\",\n});"
|
|
917
917
|
},
|
|
918
918
|
"ConsumerAuthController_mfaVerify": {
|
|
919
919
|
"actor": null,
|
|
@@ -928,7 +928,7 @@
|
|
|
928
928
|
"resource": "mfa",
|
|
929
929
|
"scope": "consumer",
|
|
930
930
|
"signature": "auth.consumer(…).mfa.verify(params, options?): Auth.ConsumerToken",
|
|
931
|
-
"snippet": "const consumerToken = await auth.consumer(\"app\").mfa.verify({ mfa_token: \"
|
|
931
|
+
"snippet": "const consumerToken = await auth.consumer(\"my-app\").mfa.verify({ mfa_token: \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\" });"
|
|
932
932
|
},
|
|
933
933
|
"ConsumerAuthController_mfaWebauthnOptions": {
|
|
934
934
|
"actor": null,
|
|
@@ -943,7 +943,7 @@
|
|
|
943
943
|
"resource": "mfa.webauthn",
|
|
944
944
|
"scope": "consumer",
|
|
945
945
|
"signature": "auth.consumer(…).mfa.webauthn.options(params, options?): Auth.ConsumerWebauthnOptions",
|
|
946
|
-
"snippet": "const consumerWebauthnOptions = await auth.consumer(\"app\").mfa.webauthn.options({ mfa_token: \"
|
|
946
|
+
"snippet": "const consumerWebauthnOptions = await auth.consumer(\"my-app\").mfa.webauthn.options({ mfa_token: \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\" });"
|
|
947
947
|
},
|
|
948
948
|
"ConsumerAuthController_passkeyOptions": {
|
|
949
949
|
"actor": null,
|
|
@@ -958,7 +958,7 @@
|
|
|
958
958
|
"resource": "passkey",
|
|
959
959
|
"scope": "consumer",
|
|
960
960
|
"signature": "auth.consumer(…).passkey.options(params?, options?): Auth.ConsumerWebauthnOptions",
|
|
961
|
-
"snippet": "const consumerWebauthnOptions = await auth.consumer(\"app\").passkey.options({ tenant_id: \"9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b\" });"
|
|
961
|
+
"snippet": "const consumerWebauthnOptions = await auth.consumer(\"my-app\").passkey.options({ tenant_id: \"9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b\" });"
|
|
962
962
|
},
|
|
963
963
|
"ConsumerAuthController_passkeyVerify": {
|
|
964
964
|
"actor": null,
|
|
@@ -973,7 +973,7 @@
|
|
|
973
973
|
"resource": "passkey",
|
|
974
974
|
"scope": "consumer",
|
|
975
975
|
"signature": "auth.consumer(…).passkey.verify(params, options?): Auth.ConsumerToken",
|
|
976
|
-
"snippet": "const consumerToken = await auth.consumer(\"app\").passkey.verify({ credential: {} });"
|
|
976
|
+
"snippet": "const consumerToken = await auth.consumer(\"my-app\").passkey.verify({ credential: {} });"
|
|
977
977
|
},
|
|
978
978
|
"ConsumerAuthController_refresh": {
|
|
979
979
|
"actor": null,
|
|
@@ -988,7 +988,7 @@
|
|
|
988
988
|
"resource": "",
|
|
989
989
|
"scope": "consumer",
|
|
990
990
|
"signature": "auth.consumer(…).refresh(params, options?): Auth.ConsumerToken",
|
|
991
|
-
"snippet": "const consumerToken = await auth.consumer(\"app\").refresh({
|
|
991
|
+
"snippet": "const consumerToken = await auth.consumer(\"my-app\").refresh({\n refresh_token: \"eyJhbGciOiJSUzI1NiIsImtpZCI6ImsxIn0.eyJ0eXAiOiJyZWZyZXNoIn0.c2lnbmF0dXJl\",\n});"
|
|
992
992
|
},
|
|
993
993
|
"ConsumerAuthController_requestPasswordReset": {
|
|
994
994
|
"actor": null,
|
|
@@ -1003,7 +1003,7 @@
|
|
|
1003
1003
|
"resource": "",
|
|
1004
1004
|
"scope": "consumer",
|
|
1005
1005
|
"signature": "auth.consumer(…).requestPasswordReset(params?, options?): Auth.ConsumerCodeIssue",
|
|
1006
|
-
"snippet": "const consumerCodeIssue = await auth.consumer(\"app\").requestPasswordReset({ email: \"jane@example.com\" });"
|
|
1006
|
+
"snippet": "const consumerCodeIssue = await auth.consumer(\"my-app\").requestPasswordReset({ email: \"jane@example.com\" });"
|
|
1007
1007
|
},
|
|
1008
1008
|
"ConsumerAuthController_requestVerification": {
|
|
1009
1009
|
"actor": null,
|
|
@@ -1018,7 +1018,7 @@
|
|
|
1018
1018
|
"resource": "",
|
|
1019
1019
|
"scope": "consumer",
|
|
1020
1020
|
"signature": "auth.consumer(…).requestVerification(params?, options?): Auth.ConsumerCodeIssue",
|
|
1021
|
-
"snippet": "const consumerCodeIssue = await auth.consumer(\"app\").requestVerification({ email: \"jane@example.com\" });"
|
|
1021
|
+
"snippet": "const consumerCodeIssue = await auth.consumer(\"my-app\").requestVerification({ email: \"jane@example.com\" });"
|
|
1022
1022
|
},
|
|
1023
1023
|
"ConsumerAuthController_resetPassword": {
|
|
1024
1024
|
"actor": null,
|
|
@@ -1033,7 +1033,7 @@
|
|
|
1033
1033
|
"resource": "",
|
|
1034
1034
|
"scope": "consumer",
|
|
1035
1035
|
"signature": "auth.consumer(…).resetPassword(params, options?): void",
|
|
1036
|
-
"snippet": "await auth.consumer(\"app\").resetPassword({ code: \"123456\", new_password: \"
|
|
1036
|
+
"snippet": "await auth.consumer(\"my-app\").resetPassword({ code: \"123456\", new_password: \"a new long passphrase 42\" });"
|
|
1037
1037
|
},
|
|
1038
1038
|
"ConsumerAuthController_sendPasswordResetEmail": {
|
|
1039
1039
|
"actor": null,
|
|
@@ -1048,7 +1048,7 @@
|
|
|
1048
1048
|
"resource": "",
|
|
1049
1049
|
"scope": "consumer",
|
|
1050
1050
|
"signature": "auth.consumer(…).sendPasswordResetEmail(params, options?): Auth.ConsumerCodeDispatch",
|
|
1051
|
-
"snippet": "const consumerCodeDispatch = await auth.consumer(\"app\").sendPasswordResetEmail({ email: \"jane@example.com\" });"
|
|
1051
|
+
"snippet": "const consumerCodeDispatch = await auth.consumer(\"my-app\").sendPasswordResetEmail({ email: \"jane@example.com\" });"
|
|
1052
1052
|
},
|
|
1053
1053
|
"ConsumerAuthController_sendVerificationEmail": {
|
|
1054
1054
|
"actor": null,
|
|
@@ -1063,7 +1063,7 @@
|
|
|
1063
1063
|
"resource": "",
|
|
1064
1064
|
"scope": "consumer",
|
|
1065
1065
|
"signature": "auth.consumer(…).sendVerificationEmail(params, options?): Auth.ConsumerCodeDispatch",
|
|
1066
|
-
"snippet": "const consumerCodeDispatch = await auth.consumer(\"app\").sendVerificationEmail({ email: \"jane@example.com\" });"
|
|
1066
|
+
"snippet": "const consumerCodeDispatch = await auth.consumer(\"my-app\").sendVerificationEmail({ email: \"jane@example.com\" });"
|
|
1067
1067
|
},
|
|
1068
1068
|
"ConsumerAuthController_signin": {
|
|
1069
1069
|
"actor": null,
|
|
@@ -1078,7 +1078,7 @@
|
|
|
1078
1078
|
"resource": "",
|
|
1079
1079
|
"scope": "consumer",
|
|
1080
1080
|
"signature": "auth.consumer(…).signin(params, options?): Auth.SigninResponse",
|
|
1081
|
-
"snippet": "const result = await auth.consumer(\"app\").signin({ identifier: \"jane_doe\", password: \"
|
|
1081
|
+
"snippet": "const result = await auth.consumer(\"my-app\").signin({ identifier: \"jane_doe\", password: \"correct horse battery staple\" });"
|
|
1082
1082
|
},
|
|
1083
1083
|
"ConsumerAuthController_signup": {
|
|
1084
1084
|
"actor": null,
|
|
@@ -1093,7 +1093,7 @@
|
|
|
1093
1093
|
"resource": "",
|
|
1094
1094
|
"scope": "consumer",
|
|
1095
1095
|
"signature": "auth.consumer(…).signup(params, options?): Auth.SignupResponse",
|
|
1096
|
-
"snippet": "const result = await auth.consumer(\"app\").signup({ email: \"jane@example.com\", password: \"CorrectHorseBatteryStaple\", username: \"john_doe\" });"
|
|
1096
|
+
"snippet": "const result = await auth.consumer(\"my-app\").signup({ email: \"jane@example.com\", password: \"CorrectHorseBatteryStaple\", username: \"john_doe\" });"
|
|
1097
1097
|
},
|
|
1098
1098
|
"ConsumerAuthController_switchTenant": {
|
|
1099
1099
|
"actor": null,
|
|
@@ -1108,7 +1108,7 @@
|
|
|
1108
1108
|
"resource": "",
|
|
1109
1109
|
"scope": "consumer",
|
|
1110
1110
|
"signature": "auth.consumer(…).switchTenant(params, options?): Auth.ConsumerToken",
|
|
1111
|
-
"snippet": "const consumerToken = await auth.consumer(\"app\").switchTenant({ tenant_id: \"
|
|
1111
|
+
"snippet": "const consumerToken = await auth.consumer(\"my-app\").switchTenant({ tenant_id: \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\" });"
|
|
1112
1112
|
},
|
|
1113
1113
|
"ConsumerAuthController_verify": {
|
|
1114
1114
|
"actor": null,
|
|
@@ -1123,7 +1123,7 @@
|
|
|
1123
1123
|
"resource": "",
|
|
1124
1124
|
"scope": "consumer",
|
|
1125
1125
|
"signature": "auth.consumer(…).verifyEmail(params, options?): Auth.ConsumerVerify",
|
|
1126
|
-
"snippet": "const consumerVerify = await auth.consumer(\"app\").verifyEmail({ code: \"123456\" });"
|
|
1126
|
+
"snippet": "const consumerVerify = await auth.consumer(\"my-app\").verifyEmail({ code: \"123456\" });"
|
|
1127
1127
|
},
|
|
1128
1128
|
"ConsumerIdpController_nativeSignIn": {
|
|
1129
1129
|
"actor": null,
|
|
@@ -1138,7 +1138,7 @@
|
|
|
1138
1138
|
"resource": "",
|
|
1139
1139
|
"scope": "consumer",
|
|
1140
1140
|
"signature": "auth.consumer(…).signinWithProvider(provider, params, options?): Auth.SigninWithProviderResponse",
|
|
1141
|
-
"snippet": "const result = await auth.consumer(\"app\").signinWithProvider(\"
|
|
1141
|
+
"snippet": "const result = await auth.consumer(\"my-app\").signinWithProvider(\"google\", {\n id_token: \"eyJhbGciOiJSUzI1NiIsImtpZCI6ImsxIn0.eyJzdWIiOiJ1c3JfMSJ9.c2lnbmF0dXJl\",\n nonce: \"n-0S6_WzA2Mj\",\n});"
|
|
1142
1142
|
},
|
|
1143
1143
|
"ConsumerIdpExchangeController_exchange": {
|
|
1144
1144
|
"actor": null,
|
|
@@ -1153,7 +1153,7 @@
|
|
|
1153
1153
|
"resource": "",
|
|
1154
1154
|
"scope": "consumer",
|
|
1155
1155
|
"signature": "auth.consumer(…).exchangeProviderCode(params, options?): Auth.Exchange",
|
|
1156
|
-
"snippet": "const exchange = await auth.consumer(\"app\").exchangeProviderCode({ code: \"
|
|
1156
|
+
"snippet": "const exchange = await auth.consumer(\"my-app\").exchangeProviderCode({ code: \"hc_8f14e45fceea167a5a36dedd4bea2543\" });"
|
|
1157
1157
|
},
|
|
1158
1158
|
"ConsumerJwksController_getDiscovery": {
|
|
1159
1159
|
"actor": null,
|
|
@@ -1168,7 +1168,7 @@
|
|
|
1168
1168
|
"resource": "wellKnown",
|
|
1169
1169
|
"scope": "consumer",
|
|
1170
1170
|
"signature": "auth.consumer(…).wellKnown.openidConfiguration(options?): Auth.OpenIdConfiguration",
|
|
1171
|
-
"snippet": "const openIdConfiguration = await auth.consumer(\"app\").wellKnown.openidConfiguration();"
|
|
1171
|
+
"snippet": "const openIdConfiguration = await auth.consumer(\"my-app\").wellKnown.openidConfiguration();"
|
|
1172
1172
|
},
|
|
1173
1173
|
"ConsumerJwksController_getJwks": {
|
|
1174
1174
|
"actor": null,
|
|
@@ -1183,7 +1183,7 @@
|
|
|
1183
1183
|
"resource": "wellKnown",
|
|
1184
1184
|
"scope": "consumer",
|
|
1185
1185
|
"signature": "auth.consumer(…).wellKnown.jwks(options?): Auth.Jwks",
|
|
1186
|
-
"snippet": "const jwks = await auth.consumer(\"app\").wellKnown.jwks();"
|
|
1186
|
+
"snippet": "const jwks = await auth.consumer(\"my-app\").wellKnown.jwks();"
|
|
1187
1187
|
},
|
|
1188
1188
|
"ConsumerMeController_acceptTenantInvite": {
|
|
1189
1189
|
"actor": null,
|
|
@@ -1198,7 +1198,7 @@
|
|
|
1198
1198
|
"resource": "me.tenantInvites",
|
|
1199
1199
|
"scope": "consumer",
|
|
1200
1200
|
"signature": "auth.consumer(…).me.tenantInvites.accept(params, options?): Auth.AcceptedTenantInvite",
|
|
1201
|
-
"snippet": "const acceptedTenantInvite = await auth.consumer(\"app\").me.tenantInvites.accept({ code: \"tinv_9dK2mQ7pR4vXbN1sT6yZ0hLcJeW3fAgU\" });"
|
|
1201
|
+
"snippet": "const acceptedTenantInvite = await auth.consumer(\"my-app\").me.tenantInvites.accept({ code: \"tinv_9dK2mQ7pR4vXbN1sT6yZ0hLcJeW3fAgU\" });"
|
|
1202
1202
|
},
|
|
1203
1203
|
"ConsumerMeController_addContact": {
|
|
1204
1204
|
"actor": null,
|
|
@@ -1213,7 +1213,7 @@
|
|
|
1213
1213
|
"resource": "me.contacts",
|
|
1214
1214
|
"scope": "consumer",
|
|
1215
1215
|
"signature": "auth.consumer(…).me.contacts.create(params, options?): Auth.MeContact",
|
|
1216
|
-
"snippet": "const meContact = await auth.consumer(\"app\").me.contacts.create({ type: \"email\", value: \"
|
|
1216
|
+
"snippet": "const meContact = await auth.consumer(\"my-app\").me.contacts.create({ type: \"email\", value: \"ada@example.com\" });"
|
|
1217
1217
|
},
|
|
1218
1218
|
"ConsumerMeController_changePassword": {
|
|
1219
1219
|
"actor": null,
|
|
@@ -1228,7 +1228,7 @@
|
|
|
1228
1228
|
"resource": "me",
|
|
1229
1229
|
"scope": "consumer",
|
|
1230
1230
|
"signature": "auth.consumer(…).me.changePassword(params, options?): void",
|
|
1231
|
-
"snippet": "await auth.consumer(\"app\").me.changePassword({
|
|
1231
|
+
"snippet": "await auth.consumer(\"my-app\").me.changePassword({\n current_password: \"correct horse battery staple\",\n new_password: \"a new long passphrase 42\",\n});"
|
|
1232
1232
|
},
|
|
1233
1233
|
"ConsumerMeController_deleteAccount": {
|
|
1234
1234
|
"actor": null,
|
|
@@ -1243,7 +1243,7 @@
|
|
|
1243
1243
|
"resource": "me",
|
|
1244
1244
|
"scope": "consumer",
|
|
1245
1245
|
"signature": "auth.consumer(…).me.deleteAccount(options?): void",
|
|
1246
|
-
"snippet": "await auth.consumer(\"app\").me.deleteAccount();"
|
|
1246
|
+
"snippet": "await auth.consumer(\"my-app\").me.deleteAccount();"
|
|
1247
1247
|
},
|
|
1248
1248
|
"ConsumerMeController_deleteContact": {
|
|
1249
1249
|
"actor": null,
|
|
@@ -1258,7 +1258,7 @@
|
|
|
1258
1258
|
"resource": "me.contacts",
|
|
1259
1259
|
"scope": "consumer",
|
|
1260
1260
|
"signature": "auth.consumer(…).me.contacts.delete(id, options?): void",
|
|
1261
|
-
"snippet": "await auth.consumer(\"app\").me.contacts.delete(\"
|
|
1261
|
+
"snippet": "await auth.consumer(\"my-app\").me.contacts.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1262
1262
|
},
|
|
1263
1263
|
"ConsumerMeController_getActivity": {
|
|
1264
1264
|
"actor": null,
|
|
@@ -1273,7 +1273,7 @@
|
|
|
1273
1273
|
"resource": "me.activity",
|
|
1274
1274
|
"scope": "consumer",
|
|
1275
1275
|
"signature": "auth.consumer(…).me.activity.list(options?): PagePromise<Auth.MeActivityEntry>",
|
|
1276
|
-
"snippet": "for await (const activity of auth.consumer(\"app\").me.activity.list()) {\n console.log(activity);\n}"
|
|
1276
|
+
"snippet": "for await (const activity of auth.consumer(\"my-app\").me.activity.list()) {\n console.log(activity);\n}"
|
|
1277
1277
|
},
|
|
1278
1278
|
"ConsumerMeController_getPermissions": {
|
|
1279
1279
|
"actor": null,
|
|
@@ -1288,7 +1288,7 @@
|
|
|
1288
1288
|
"resource": "me",
|
|
1289
1289
|
"scope": "consumer",
|
|
1290
1290
|
"signature": "auth.consumer(…).me.permissions(options?): Auth.MePermissions",
|
|
1291
|
-
"snippet": "const mePermissions = await auth.consumer(\"app\").me.permissions();"
|
|
1291
|
+
"snippet": "const mePermissions = await auth.consumer(\"my-app\").me.permissions();"
|
|
1292
1292
|
},
|
|
1293
1293
|
"ConsumerMeController_getProfile": {
|
|
1294
1294
|
"actor": null,
|
|
@@ -1303,7 +1303,7 @@
|
|
|
1303
1303
|
"resource": "me",
|
|
1304
1304
|
"scope": "consumer",
|
|
1305
1305
|
"signature": "auth.consumer(…).me.retrieve(options?): Auth.MeProfile",
|
|
1306
|
-
"snippet": "const meProfile = await auth.consumer(\"app\").me.retrieve();"
|
|
1306
|
+
"snippet": "const meProfile = await auth.consumer(\"my-app\").me.retrieve();"
|
|
1307
1307
|
},
|
|
1308
1308
|
"ConsumerMeController_listContacts": {
|
|
1309
1309
|
"actor": null,
|
|
@@ -1318,7 +1318,7 @@
|
|
|
1318
1318
|
"resource": "me.contacts",
|
|
1319
1319
|
"scope": "consumer",
|
|
1320
1320
|
"signature": "auth.consumer(…).me.contacts.list(options?): Auth.MeContacts",
|
|
1321
|
-
"snippet": "const meContacts = await auth.consumer(\"app\").me.contacts.list();"
|
|
1321
|
+
"snippet": "const meContacts = await auth.consumer(\"my-app\").me.contacts.list();"
|
|
1322
1322
|
},
|
|
1323
1323
|
"ConsumerMeController_listSessions": {
|
|
1324
1324
|
"actor": null,
|
|
@@ -1333,7 +1333,7 @@
|
|
|
1333
1333
|
"resource": "me.sessions",
|
|
1334
1334
|
"scope": "consumer",
|
|
1335
1335
|
"signature": "auth.consumer(…).me.sessions.list(options?): PagePromise<Auth.MeSession>",
|
|
1336
|
-
"snippet": "for await (const session of auth.consumer(\"app\").me.sessions.list()) {\n console.log(session);\n}"
|
|
1336
|
+
"snippet": "for await (const session of auth.consumer(\"my-app\").me.sessions.list()) {\n console.log(session);\n}"
|
|
1337
1337
|
},
|
|
1338
1338
|
"ConsumerMeController_promoteContact": {
|
|
1339
1339
|
"actor": null,
|
|
@@ -1348,7 +1348,7 @@
|
|
|
1348
1348
|
"resource": "me.contacts",
|
|
1349
1349
|
"scope": "consumer",
|
|
1350
1350
|
"signature": "auth.consumer(…).me.contacts.promote(id, options?): void",
|
|
1351
|
-
"snippet": "await auth.consumer(\"app\").me.contacts.promote(\"
|
|
1351
|
+
"snippet": "await auth.consumer(\"my-app\").me.contacts.promote(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1352
1352
|
},
|
|
1353
1353
|
"ConsumerMeController_removeAvatar": {
|
|
1354
1354
|
"actor": null,
|
|
@@ -1363,7 +1363,7 @@
|
|
|
1363
1363
|
"resource": "me",
|
|
1364
1364
|
"scope": "consumer",
|
|
1365
1365
|
"signature": "auth.consumer(…).me.deleteAvatar(options?): void",
|
|
1366
|
-
"snippet": "await auth.consumer(\"app\").me.deleteAvatar();"
|
|
1366
|
+
"snippet": "await auth.consumer(\"my-app\").me.deleteAvatar();"
|
|
1367
1367
|
},
|
|
1368
1368
|
"ConsumerMeController_revokeSession": {
|
|
1369
1369
|
"actor": null,
|
|
@@ -1378,7 +1378,7 @@
|
|
|
1378
1378
|
"resource": "me.sessions",
|
|
1379
1379
|
"scope": "consumer",
|
|
1380
1380
|
"signature": "auth.consumer(…).me.sessions.delete(id, options?): void",
|
|
1381
|
-
"snippet": "await auth.consumer(\"app\").me.sessions.delete(\"
|
|
1381
|
+
"snippet": "await auth.consumer(\"my-app\").me.sessions.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1382
1382
|
},
|
|
1383
1383
|
"ConsumerMeController_setAvatar": {
|
|
1384
1384
|
"actor": null,
|
|
@@ -1393,7 +1393,7 @@
|
|
|
1393
1393
|
"resource": "me",
|
|
1394
1394
|
"scope": "consumer",
|
|
1395
1395
|
"signature": "auth.consumer(…).me.uploadAvatar(params, options?): Auth.AvatarUrl",
|
|
1396
|
-
"snippet": "const avatarUrl = await auth.consumer(\"app\").me.uploadAvatar({ file: new File([\"…\"], \"image.png\", { type: \"image/png\" }) });"
|
|
1396
|
+
"snippet": "const avatarUrl = await auth.consumer(\"my-app\").me.uploadAvatar({ file: new File([\"…\"], \"image.png\", { type: \"image/png\" }) });"
|
|
1397
1397
|
},
|
|
1398
1398
|
"ConsumerMeController_updateProfile": {
|
|
1399
1399
|
"actor": null,
|
|
@@ -1408,7 +1408,7 @@
|
|
|
1408
1408
|
"resource": "me",
|
|
1409
1409
|
"scope": "consumer",
|
|
1410
1410
|
"signature": "auth.consumer(…).me.update(params?, options?): Auth.MeUpdatedAccount",
|
|
1411
|
-
"snippet": "const meUpdatedAccount = await auth.consumer(\"app\").me.update({ display_name: \"Ada Lovelace\" });"
|
|
1411
|
+
"snippet": "const meUpdatedAccount = await auth.consumer(\"my-app\").me.update({ display_name: \"Ada Lovelace\" });"
|
|
1412
1412
|
},
|
|
1413
1413
|
"ConsumerMfaController_confirmEnrollment": {
|
|
1414
1414
|
"actor": null,
|
|
@@ -1423,7 +1423,7 @@
|
|
|
1423
1423
|
"resource": "me.mfa.factors",
|
|
1424
1424
|
"scope": "consumer",
|
|
1425
1425
|
"signature": "auth.consumer(…).me.mfa.factors.verify(id, params?, options?): Auth.ConfirmEnrollment",
|
|
1426
|
-
"snippet": "const confirmEnrollment = await auth.consumer(\"app\").me.mfa.factors.verify(\"
|
|
1426
|
+
"snippet": "const confirmEnrollment = await auth.consumer(\"my-app\").me.mfa.factors.verify(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { code: \"123456\" });"
|
|
1427
1427
|
},
|
|
1428
1428
|
"ConsumerMfaController_disable": {
|
|
1429
1429
|
"actor": null,
|
|
@@ -1438,7 +1438,7 @@
|
|
|
1438
1438
|
"resource": "me.mfa.factors",
|
|
1439
1439
|
"scope": "consumer",
|
|
1440
1440
|
"signature": "auth.consumer(…).me.mfa.factors.delete(id, options?): void",
|
|
1441
|
-
"snippet": "await auth.consumer(\"app\").me.mfa.factors.delete(\"
|
|
1441
|
+
"snippet": "await auth.consumer(\"my-app\").me.mfa.factors.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1442
1442
|
},
|
|
1443
1443
|
"ConsumerMfaController_list": {
|
|
1444
1444
|
"actor": null,
|
|
@@ -1453,7 +1453,7 @@
|
|
|
1453
1453
|
"resource": "me.mfa.factors",
|
|
1454
1454
|
"scope": "consumer",
|
|
1455
1455
|
"signature": "auth.consumer(…).me.mfa.factors.list(options?): Auth.FactorList",
|
|
1456
|
-
"snippet": "const factorList = await auth.consumer(\"app\").me.mfa.factors.list();"
|
|
1456
|
+
"snippet": "const factorList = await auth.consumer(\"my-app\").me.mfa.factors.list();"
|
|
1457
1457
|
},
|
|
1458
1458
|
"ConsumerMfaController_regenerateRecoveryCodes": {
|
|
1459
1459
|
"actor": null,
|
|
@@ -1468,7 +1468,7 @@
|
|
|
1468
1468
|
"resource": "me.mfa.recoveryCodes",
|
|
1469
1469
|
"scope": "consumer",
|
|
1470
1470
|
"signature": "auth.consumer(…).me.mfa.recoveryCodes.regenerate(options?): Auth.RecoveryCodes",
|
|
1471
|
-
"snippet": "const recoveryCodes = await auth.consumer(\"app\").me.mfa.recoveryCodes.regenerate();"
|
|
1471
|
+
"snippet": "const recoveryCodes = await auth.consumer(\"my-app\").me.mfa.recoveryCodes.regenerate();"
|
|
1472
1472
|
},
|
|
1473
1473
|
"ConsumerMfaController_startEnrollment": {
|
|
1474
1474
|
"actor": null,
|
|
@@ -1483,7 +1483,7 @@
|
|
|
1483
1483
|
"resource": "me.mfa.factors",
|
|
1484
1484
|
"scope": "consumer",
|
|
1485
1485
|
"signature": "auth.consumer(…).me.mfa.factors.create(params, options?): Auth.StartEnrollment",
|
|
1486
|
-
"snippet": "const startEnrollment = await auth.consumer(\"app\").me.mfa.factors.create({ type: \"totp\" });"
|
|
1486
|
+
"snippet": "const startEnrollment = await auth.consumer(\"my-app\").me.mfa.factors.create({ type: \"totp\" });"
|
|
1487
1487
|
},
|
|
1488
1488
|
"ConsumerMfaController_stepUp": {
|
|
1489
1489
|
"actor": null,
|
|
@@ -1498,7 +1498,7 @@
|
|
|
1498
1498
|
"resource": "me.mfa.stepUp",
|
|
1499
1499
|
"scope": "consumer",
|
|
1500
1500
|
"signature": "auth.consumer(…).me.mfa.stepUp.verify(params?, options?): Auth.StepUp",
|
|
1501
|
-
"snippet": "const stepUp = await auth.consumer(\"app\").me.mfa.stepUp.verify({ code: \"123456\" });"
|
|
1501
|
+
"snippet": "const stepUp = await auth.consumer(\"my-app\").me.mfa.stepUp.verify({ code: \"123456\" });"
|
|
1502
1502
|
},
|
|
1503
1503
|
"ConsumerMfaController_stepUpSendCode": {
|
|
1504
1504
|
"actor": null,
|
|
@@ -1513,7 +1513,7 @@
|
|
|
1513
1513
|
"resource": "me.mfa.stepUp",
|
|
1514
1514
|
"scope": "consumer",
|
|
1515
1515
|
"signature": "auth.consumer(…).me.mfa.stepUp.sendCode(params?, options?): Auth.StepUpSendCode",
|
|
1516
|
-
"snippet": "const stepUpSendCode = await auth.consumer(\"app\").me.mfa.stepUp.sendCode({ factor_id: \"9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b\" });"
|
|
1516
|
+
"snippet": "const stepUpSendCode = await auth.consumer(\"my-app\").me.mfa.stepUp.sendCode({ factor_id: \"9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b\" });"
|
|
1517
1517
|
},
|
|
1518
1518
|
"ConsumerMfaController_stepUpWebauthnOptions": {
|
|
1519
1519
|
"actor": null,
|
|
@@ -1528,7 +1528,7 @@
|
|
|
1528
1528
|
"resource": "me.mfa.stepUp.webauthn",
|
|
1529
1529
|
"scope": "consumer",
|
|
1530
1530
|
"signature": "auth.consumer(…).me.mfa.stepUp.webauthn.options(options?): Auth.WebauthnOptions",
|
|
1531
|
-
"snippet": "const webauthnOptions = await auth.consumer(\"app\").me.mfa.stepUp.webauthn.options();"
|
|
1531
|
+
"snippet": "const webauthnOptions = await auth.consumer(\"my-app\").me.mfa.stepUp.webauthn.options();"
|
|
1532
1532
|
},
|
|
1533
1533
|
"ConsumerOAuthController_clientCredentials": {
|
|
1534
1534
|
"actor": null,
|
|
@@ -1543,7 +1543,7 @@
|
|
|
1543
1543
|
"resource": "oauth",
|
|
1544
1544
|
"scope": "consumer",
|
|
1545
1545
|
"signature": "auth.consumer(…).oauth.token(params, options?): Auth.OAuthToken",
|
|
1546
|
-
"snippet": "const oAuthToken = await auth.consumer(\"app\").oauth.token({\n client_id: \"m2m_a1b2c3d4e5f6...\",\n client_secret: \"
|
|
1546
|
+
"snippet": "const oAuthToken = await auth.consumer(\"my-app\").oauth.token({\n client_id: \"m2m_a1b2c3d4e5f6...\",\n client_secret: \"the-secret-returned-by-credentials-create\",\n grant_type: \"client_credentials\",\n});"
|
|
1547
1547
|
},
|
|
1548
1548
|
"ConsumerOAuthController_introspect": {
|
|
1549
1549
|
"actor": null,
|
|
@@ -1558,7 +1558,7 @@
|
|
|
1558
1558
|
"resource": "oauth",
|
|
1559
1559
|
"scope": "consumer",
|
|
1560
1560
|
"signature": "auth.consumer(…).oauth.introspect(params?, options?): Auth.Introspect",
|
|
1561
|
-
"snippet": "const introspect = await auth.consumer(\"app\").oauth.introspect({ token: \"
|
|
1561
|
+
"snippet": "const introspect = await auth.consumer(\"my-app\").oauth.introspect({ token: \"eyJhbGciOiJSUzI1NiIsImtpZCI6ImsxIn0.eyJzdWIiOiJ1c3JfMSJ9.c2lnbmF0dXJl\" });"
|
|
1562
1562
|
},
|
|
1563
1563
|
"ConsumerTenantApiKeysController_create": {
|
|
1564
1564
|
"actor": null,
|
|
@@ -1573,7 +1573,7 @@
|
|
|
1573
1573
|
"resource": "tenantApiKeys",
|
|
1574
1574
|
"scope": "consumer",
|
|
1575
1575
|
"signature": "auth.consumer(…).tenantApiKeys.create(params, options?): Auth.TenantApiKeyWithSecret",
|
|
1576
|
-
"snippet": "const tenantApiKeyWithSecret = await auth.consumer(\"app\").tenantApiKeys.create({ name: \"CI e2e\", scopes: [\"disputes.read\", \"audit.read\"] });"
|
|
1576
|
+
"snippet": "const tenantApiKeyWithSecret = await auth.consumer(\"my-app\").tenantApiKeys.create({ name: \"CI e2e\", scopes: [\"disputes.read\", \"audit.read\"] });"
|
|
1577
1577
|
},
|
|
1578
1578
|
"ConsumerTenantApiKeysController_list": {
|
|
1579
1579
|
"actor": null,
|
|
@@ -1588,7 +1588,7 @@
|
|
|
1588
1588
|
"resource": "tenantApiKeys",
|
|
1589
1589
|
"scope": "consumer",
|
|
1590
1590
|
"signature": "auth.consumer(…).tenantApiKeys.list(params?, options?): PagePromise<Auth.TenantApiKey>",
|
|
1591
|
-
"snippet": "for await (const tenantApiKey of auth.consumer(\"app\").tenantApiKeys.list()) {\n console.log(tenantApiKey);\n}\nconst page = await auth.consumer(\"app\").tenantApiKeys.list({}, { timeout: 5_000 });"
|
|
1591
|
+
"snippet": "for await (const tenantApiKey of auth.consumer(\"my-app\").tenantApiKeys.list()) {\n console.log(tenantApiKey);\n}\nconst page = await auth.consumer(\"my-app\").tenantApiKeys.list({}, { timeout: 5_000 });"
|
|
1592
1592
|
},
|
|
1593
1593
|
"ConsumerTenantApiKeysController_revoke": {
|
|
1594
1594
|
"actor": null,
|
|
@@ -1603,7 +1603,7 @@
|
|
|
1603
1603
|
"resource": "tenantApiKeys",
|
|
1604
1604
|
"scope": "consumer",
|
|
1605
1605
|
"signature": "auth.consumer(…).tenantApiKeys.delete(keyId, options?): void",
|
|
1606
|
-
"snippet": "await auth.consumer(\"app\").tenantApiKeys.delete(\"
|
|
1606
|
+
"snippet": "await auth.consumer(\"my-app\").tenantApiKeys.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1607
1607
|
},
|
|
1608
1608
|
"ConsumerTenantApiKeysController_rotate": {
|
|
1609
1609
|
"actor": null,
|
|
@@ -1618,7 +1618,7 @@
|
|
|
1618
1618
|
"resource": "tenantApiKeys",
|
|
1619
1619
|
"scope": "consumer",
|
|
1620
1620
|
"signature": "auth.consumer(…).tenantApiKeys.rotate(keyId, params?, options?): Auth.TenantApiKeyWithSecret",
|
|
1621
|
-
"snippet": "const tenantApiKeyWithSecret = await auth.consumer(\"app\").tenantApiKeys.rotate(\"
|
|
1621
|
+
"snippet": "const tenantApiKeyWithSecret = await auth.consumer(\"my-app\").tenantApiKeys.rotate(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { expires_in_days: 7 });"
|
|
1622
1622
|
},
|
|
1623
1623
|
"ConsumerTenantsController_addMember": {
|
|
1624
1624
|
"actor": null,
|
|
@@ -1633,7 +1633,7 @@
|
|
|
1633
1633
|
"resource": "tenants.members",
|
|
1634
1634
|
"scope": "consumer",
|
|
1635
1635
|
"signature": "auth.consumer(…).tenants.members.create(tenantId, params, options?): Auth.ConsumerAddMember",
|
|
1636
|
-
"snippet": "const consumerAddMember = await auth.consumer(\"app\").tenants.members.create(\"
|
|
1636
|
+
"snippet": "const consumerAddMember = await auth.consumer(\"my-app\").tenants.members.create(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { role_name: \"member\" });"
|
|
1637
1637
|
},
|
|
1638
1638
|
"ConsumerTenantsController_create": {
|
|
1639
1639
|
"actor": null,
|
|
@@ -1648,7 +1648,7 @@
|
|
|
1648
1648
|
"resource": "tenants",
|
|
1649
1649
|
"scope": "consumer",
|
|
1650
1650
|
"signature": "auth.consumer(…).tenants.create(params, options?): Auth.ConsumerTenant",
|
|
1651
|
-
"snippet": "const consumerTenant = await auth.consumer(\"app\").tenants.create({ display_name: \"Acme Co\" });"
|
|
1651
|
+
"snippet": "const consumerTenant = await auth.consumer(\"my-app\").tenants.create({ display_name: \"Acme Co\" });"
|
|
1652
1652
|
},
|
|
1653
1653
|
"ConsumerTenantsController_createInvite": {
|
|
1654
1654
|
"actor": null,
|
|
@@ -1663,7 +1663,7 @@
|
|
|
1663
1663
|
"resource": "tenants.invites",
|
|
1664
1664
|
"scope": "consumer",
|
|
1665
1665
|
"signature": "auth.consumer(…).tenants.invites.create(tenantId, params, options?): Auth.CreateTenantInvite",
|
|
1666
|
-
"snippet": "const createTenantInvite = await auth.consumer(\"app\").tenants.invites.create(\"
|
|
1666
|
+
"snippet": "const createTenantInvite = await auth.consumer(\"my-app\").tenants.invites.create(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { email: \"alice@example.com\", role_name: \"member\" });"
|
|
1667
1667
|
},
|
|
1668
1668
|
"ConsumerTenantsController_delete": {
|
|
1669
1669
|
"actor": null,
|
|
@@ -1678,7 +1678,7 @@
|
|
|
1678
1678
|
"resource": "tenants",
|
|
1679
1679
|
"scope": "consumer",
|
|
1680
1680
|
"signature": "auth.consumer(…).tenants.delete(tenantId, options?): void",
|
|
1681
|
-
"snippet": "await auth.consumer(\"app\").tenants.delete(\"
|
|
1681
|
+
"snippet": "await auth.consumer(\"my-app\").tenants.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1682
1682
|
},
|
|
1683
1683
|
"ConsumerTenantsController_get": {
|
|
1684
1684
|
"actor": null,
|
|
@@ -1693,7 +1693,7 @@
|
|
|
1693
1693
|
"resource": "tenants",
|
|
1694
1694
|
"scope": "consumer",
|
|
1695
1695
|
"signature": "auth.consumer(…).tenants.retrieve(tenantId, options?): Auth.ConsumerTenant",
|
|
1696
|
-
"snippet": "const consumerTenant = await auth.consumer(\"app\").tenants.retrieve(\"
|
|
1696
|
+
"snippet": "const consumerTenant = await auth.consumer(\"my-app\").tenants.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1697
1697
|
},
|
|
1698
1698
|
"ConsumerTenantsController_list": {
|
|
1699
1699
|
"actor": null,
|
|
@@ -1708,7 +1708,7 @@
|
|
|
1708
1708
|
"resource": "tenants",
|
|
1709
1709
|
"scope": "consumer",
|
|
1710
1710
|
"signature": "auth.consumer(…).tenants.list(params?, options?): PagePromise<Auth.ConsumerTenant>",
|
|
1711
|
-
"snippet": "for await (const tenant of auth.consumer(\"app\").tenants.list()) {\n console.log(tenant);\n}\nconst page = await auth.consumer(\"app\").tenants.list({}, { timeout: 5_000 });"
|
|
1711
|
+
"snippet": "for await (const tenant of auth.consumer(\"my-app\").tenants.list()) {\n console.log(tenant);\n}\nconst page = await auth.consumer(\"my-app\").tenants.list({}, { timeout: 5_000 });"
|
|
1712
1712
|
},
|
|
1713
1713
|
"ConsumerTenantsController_listInvites": {
|
|
1714
1714
|
"actor": null,
|
|
@@ -1723,7 +1723,7 @@
|
|
|
1723
1723
|
"resource": "tenants.invites",
|
|
1724
1724
|
"scope": "consumer",
|
|
1725
1725
|
"signature": "auth.consumer(…).tenants.invites.list(tenantId, params?, options?): PagePromise<Auth.TenantInvite>",
|
|
1726
|
-
"snippet": "for await (const invite of auth.consumer(\"app\").tenants.invites.list(\"
|
|
1726
|
+
"snippet": "for await (const invite of auth.consumer(\"my-app\").tenants.invites.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\")) {\n console.log(invite);\n}\nconst page = await auth.consumer(\"my-app\").tenants.invites.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", {}, { timeout: 5_000 });"
|
|
1727
1727
|
},
|
|
1728
1728
|
"ConsumerTenantsController_listMembers": {
|
|
1729
1729
|
"actor": null,
|
|
@@ -1738,7 +1738,7 @@
|
|
|
1738
1738
|
"resource": "tenants.members",
|
|
1739
1739
|
"scope": "consumer",
|
|
1740
1740
|
"signature": "auth.consumer(…).tenants.members.list(tenantId, params?, options?): PagePromise<Auth.ConsumerTenantMembership>",
|
|
1741
|
-
"snippet": "for await (const member of auth.consumer(\"app\").tenants.members.list(\"
|
|
1741
|
+
"snippet": "for await (const member of auth.consumer(\"my-app\").tenants.members.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\")) {\n console.log(member);\n}\nconst page = await auth.consumer(\"my-app\").tenants.members.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", {}, { timeout: 5_000 });"
|
|
1742
1742
|
},
|
|
1743
1743
|
"ConsumerTenantsController_removeMember": {
|
|
1744
1744
|
"actor": null,
|
|
@@ -1753,7 +1753,7 @@
|
|
|
1753
1753
|
"resource": "tenants.members",
|
|
1754
1754
|
"scope": "consumer",
|
|
1755
1755
|
"signature": "auth.consumer(…).tenants.members.delete(tenantId, accountId, options?): void",
|
|
1756
|
-
"snippet": "await auth.consumer(\"app\").tenants.members.delete(\"
|
|
1756
|
+
"snippet": "await auth.consumer(\"my-app\").tenants.members.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1757
1757
|
},
|
|
1758
1758
|
"ConsumerTenantsController_revokeInvite": {
|
|
1759
1759
|
"actor": null,
|
|
@@ -1768,7 +1768,7 @@
|
|
|
1768
1768
|
"resource": "tenants.invites",
|
|
1769
1769
|
"scope": "consumer",
|
|
1770
1770
|
"signature": "auth.consumer(…).tenants.invites.delete(tenantId, inviteId, options?): void",
|
|
1771
|
-
"snippet": "await auth.consumer(\"app\").tenants.invites.delete(\"
|
|
1771
|
+
"snippet": "await auth.consumer(\"my-app\").tenants.invites.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1772
1772
|
},
|
|
1773
1773
|
"ConsumerTenantsController_update": {
|
|
1774
1774
|
"actor": null,
|
|
@@ -1783,7 +1783,7 @@
|
|
|
1783
1783
|
"resource": "tenants",
|
|
1784
1784
|
"scope": "consumer",
|
|
1785
1785
|
"signature": "auth.consumer(…).tenants.update(tenantId, params?, options?): Auth.ConsumerTenant",
|
|
1786
|
-
"snippet": "const consumerTenant = await auth.consumer(\"app\").tenants.update(\"
|
|
1786
|
+
"snippet": "const consumerTenant = await auth.consumer(\"my-app\").tenants.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { display_name: \"Acme Inc\" });"
|
|
1787
1787
|
},
|
|
1788
1788
|
"ConsumerTenantsController_updateMemberRole": {
|
|
1789
1789
|
"actor": null,
|
|
@@ -1798,7 +1798,7 @@
|
|
|
1798
1798
|
"resource": "tenants.members",
|
|
1799
1799
|
"scope": "consumer",
|
|
1800
1800
|
"signature": "auth.consumer(…).tenants.members.update(tenantId, accountId, params, options?): Auth.ConsumerTenantMembership",
|
|
1801
|
-
"snippet": "const consumerTenantMembership = await auth.consumer(\"app\").tenants.members.update(\"
|
|
1801
|
+
"snippet": "const consumerTenantMembership = await auth.consumer(\"my-app\").tenants.members.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { role_name: \"admin\" });"
|
|
1802
1802
|
},
|
|
1803
1803
|
"ConsumerVerifyController_authorize": {
|
|
1804
1804
|
"actor": null,
|
|
@@ -1813,7 +1813,7 @@
|
|
|
1813
1813
|
"resource": "verify",
|
|
1814
1814
|
"scope": "consumer",
|
|
1815
1815
|
"signature": "auth.consumer(…).verify.authorize(params?, options?): Auth.Authorize",
|
|
1816
|
-
"snippet": "const authorize = await auth.consumer(\"app\").verify.authorize({ permission: \"
|
|
1816
|
+
"snippet": "const authorize = await auth.consumer(\"my-app\").verify.authorize({ permission: \"invoice.read\" });"
|
|
1817
1817
|
},
|
|
1818
1818
|
"ConsumerVerifyController_authorizeBatch": {
|
|
1819
1819
|
"actor": null,
|
|
@@ -1828,7 +1828,7 @@
|
|
|
1828
1828
|
"resource": "verify",
|
|
1829
1829
|
"scope": "consumer",
|
|
1830
1830
|
"signature": "auth.consumer(…).verify.authorizeBatch(params, options?): Auth.AuthorizeBatch",
|
|
1831
|
-
"snippet": "const authorizeBatch = await auth.consumer(\"app\").verify.authorizeBatch({ checks: [{}] });"
|
|
1831
|
+
"snippet": "const authorizeBatch = await auth.consumer(\"my-app\").verify.authorizeBatch({ checks: [{}] });"
|
|
1832
1832
|
},
|
|
1833
1833
|
"ConsumerVerifyController_verify": {
|
|
1834
1834
|
"actor": null,
|
|
@@ -1843,7 +1843,7 @@
|
|
|
1843
1843
|
"resource": "verify",
|
|
1844
1844
|
"scope": "consumer",
|
|
1845
1845
|
"signature": "auth.consumer(…).verify.token(params?, options?): Auth.Verify",
|
|
1846
|
-
"snippet": "const verify = await auth.consumer(\"app\").verify.token({ token: \"
|
|
1846
|
+
"snippet": "const verify = await auth.consumer(\"my-app\").verify.token({ token: \"eyJhbGciOiJSUzI1NiIsImtpZCI6ImsxIn0.eyJzdWIiOiJ1c3JfMSJ9.c2lnbmF0dXJl\" });"
|
|
1847
1847
|
},
|
|
1848
1848
|
"CustomDomainController_apply": {
|
|
1849
1849
|
"actor": null,
|
|
@@ -1858,7 +1858,7 @@
|
|
|
1858
1858
|
"resource": "customDomains",
|
|
1859
1859
|
"scope": "app",
|
|
1860
1860
|
"signature": "auth.admin.app(…).customDomains.apply(domainId, params, options?): Auth.CustomDomainApplyResult",
|
|
1861
|
-
"snippet": "const customDomainApplyResult = await auth.admin.app(\"
|
|
1861
|
+
"snippet": "const customDomainApplyResult = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").customDomains.apply(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { dry_run: true, provider: \"cloudflare\", token: \"cf-token-from-your-dashboard\" });"
|
|
1862
1862
|
},
|
|
1863
1863
|
"CustomDomainController_check": {
|
|
1864
1864
|
"actor": null,
|
|
@@ -1873,7 +1873,7 @@
|
|
|
1873
1873
|
"resource": "customDomains",
|
|
1874
1874
|
"scope": "app",
|
|
1875
1875
|
"signature": "auth.admin.app(…).customDomains.check(domainId, options?): Auth.CustomDomain",
|
|
1876
|
-
"snippet": "const customDomain = await auth.admin.app(\"
|
|
1876
|
+
"snippet": "const customDomain = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").customDomains.check(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1877
1877
|
},
|
|
1878
1878
|
"CustomDomainController_create": {
|
|
1879
1879
|
"actor": null,
|
|
@@ -1888,7 +1888,7 @@
|
|
|
1888
1888
|
"resource": "customDomains",
|
|
1889
1889
|
"scope": "app",
|
|
1890
1890
|
"signature": "auth.admin.app(…).customDomains.create(params, options?): Auth.CustomDomain",
|
|
1891
|
-
"snippet": "const customDomain = await auth.admin.app(\"
|
|
1891
|
+
"snippet": "const customDomain = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").customDomains.create({ hostname: \"auth.acme.com\" });"
|
|
1892
1892
|
},
|
|
1893
1893
|
"CustomDomainController_export": {
|
|
1894
1894
|
"actor": null,
|
|
@@ -1903,7 +1903,7 @@
|
|
|
1903
1903
|
"resource": "customDomains",
|
|
1904
1904
|
"scope": "app",
|
|
1905
1905
|
"signature": "auth.admin.app(…).customDomains.export(domainId, params, options?): Response",
|
|
1906
|
-
"snippet": "const response = await auth.admin.app(\"
|
|
1906
|
+
"snippet": "const response = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").customDomains.export(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { format: \"bind\" });\nconst text = await response.text();"
|
|
1907
1907
|
},
|
|
1908
1908
|
"CustomDomainController_get": {
|
|
1909
1909
|
"actor": null,
|
|
@@ -1918,7 +1918,7 @@
|
|
|
1918
1918
|
"resource": "customDomains",
|
|
1919
1919
|
"scope": "app",
|
|
1920
1920
|
"signature": "auth.admin.app(…).customDomains.retrieve(domainId, options?): Auth.CustomDomain",
|
|
1921
|
-
"snippet": "const customDomain = await auth.admin.app(\"
|
|
1921
|
+
"snippet": "const customDomain = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").customDomains.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1922
1922
|
},
|
|
1923
1923
|
"CustomDomainController_list": {
|
|
1924
1924
|
"actor": null,
|
|
@@ -1933,7 +1933,7 @@
|
|
|
1933
1933
|
"resource": "customDomains",
|
|
1934
1934
|
"scope": "app",
|
|
1935
1935
|
"signature": "auth.admin.app(…).customDomains.list(options?): PagePromise<Auth.CustomDomain>",
|
|
1936
|
-
"snippet": "for await (const customDomain of auth.admin.app(\"
|
|
1936
|
+
"snippet": "for await (const customDomain of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").customDomains.list()) {\n console.log(customDomain);\n}"
|
|
1937
1937
|
},
|
|
1938
1938
|
"CustomDomainController_remove": {
|
|
1939
1939
|
"actor": null,
|
|
@@ -1948,7 +1948,7 @@
|
|
|
1948
1948
|
"resource": "customDomains",
|
|
1949
1949
|
"scope": "app",
|
|
1950
1950
|
"signature": "auth.admin.app(…).customDomains.delete(domainId, options?): void",
|
|
1951
|
-
"snippet": "await auth.admin.app(\"
|
|
1951
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").customDomains.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
1952
1952
|
},
|
|
1953
1953
|
"EndUserController_addContact": {
|
|
1954
1954
|
"actor": null,
|
|
@@ -1963,7 +1963,7 @@
|
|
|
1963
1963
|
"resource": "endUsers.contacts",
|
|
1964
1964
|
"scope": "app",
|
|
1965
1965
|
"signature": "auth.admin.app(…).endUsers.contacts.create(userId, params, options?): Auth.AccountContact",
|
|
1966
|
-
"snippet": "const accountContact = await auth.admin.app(\"
|
|
1966
|
+
"snippet": "const accountContact = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.contacts.create(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { type: \"email\", value: \"ada@example.com\" });"
|
|
1967
1967
|
},
|
|
1968
1968
|
"EndUserController_bulkDelete": {
|
|
1969
1969
|
"actor": null,
|
|
@@ -1978,7 +1978,7 @@
|
|
|
1978
1978
|
"resource": "endUsers",
|
|
1979
1979
|
"scope": "app",
|
|
1980
1980
|
"signature": "auth.admin.app(…).endUsers.bulkDelete(params, options?): Auth.BulkAffectedUsers",
|
|
1981
|
-
"snippet": "const bulkAffectedUsers = await auth.admin.app(\"
|
|
1981
|
+
"snippet": "const bulkAffectedUsers = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.bulkDelete({ selection: { mode: \"ids\" } });"
|
|
1982
1982
|
},
|
|
1983
1983
|
"EndUserController_bulkRevokeSessions": {
|
|
1984
1984
|
"actor": null,
|
|
@@ -1993,7 +1993,7 @@
|
|
|
1993
1993
|
"resource": "endUsers",
|
|
1994
1994
|
"scope": "app",
|
|
1995
1995
|
"signature": "auth.admin.app(…).endUsers.bulkRevokeSessions(params, options?): Auth.BulkAffectedUsers",
|
|
1996
|
-
"snippet": "const bulkAffectedUsers = await auth.admin.app(\"
|
|
1996
|
+
"snippet": "const bulkAffectedUsers = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.bulkRevokeSessions({ selection: { mode: \"ids\" } });"
|
|
1997
1997
|
},
|
|
1998
1998
|
"EndUserController_bulkUpdateRole": {
|
|
1999
1999
|
"actor": null,
|
|
@@ -2008,7 +2008,7 @@
|
|
|
2008
2008
|
"resource": "endUsers",
|
|
2009
2009
|
"scope": "app",
|
|
2010
2010
|
"signature": "auth.admin.app(…).endUsers.bulkUpdateRole(params, options?): Auth.BulkAffectedUsers",
|
|
2011
|
-
"snippet": "const bulkAffectedUsers = await auth.admin.app(\"
|
|
2011
|
+
"snippet": "const bulkAffectedUsers = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.bulkUpdateRole({ role_name: \"member\", selection: { mode: \"ids\" } });"
|
|
2012
2012
|
},
|
|
2013
2013
|
"EndUserController_bulkUpdateStatus": {
|
|
2014
2014
|
"actor": null,
|
|
@@ -2023,7 +2023,7 @@
|
|
|
2023
2023
|
"resource": "endUsers",
|
|
2024
2024
|
"scope": "app",
|
|
2025
2025
|
"signature": "auth.admin.app(…).endUsers.bulkUpdateStatus(params, options?): Auth.BulkAffectedUsers",
|
|
2026
|
-
"snippet": "const bulkAffectedUsers = await auth.admin.app(\"
|
|
2026
|
+
"snippet": "const bulkAffectedUsers = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.bulkUpdateStatus({ selection: { mode: \"ids\" }, status: \"suspended\" });"
|
|
2027
2027
|
},
|
|
2028
2028
|
"EndUserController_deleteContact": {
|
|
2029
2029
|
"actor": null,
|
|
@@ -2038,7 +2038,7 @@
|
|
|
2038
2038
|
"resource": "endUsers.contacts",
|
|
2039
2039
|
"scope": "app",
|
|
2040
2040
|
"signature": "auth.admin.app(…).endUsers.contacts.delete(userId, contactId, options?): void",
|
|
2041
|
-
"snippet": "await auth.admin.app(\"
|
|
2041
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.contacts.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2042
2042
|
},
|
|
2043
2043
|
"EndUserController_deleteEndUser": {
|
|
2044
2044
|
"actor": null,
|
|
@@ -2053,7 +2053,7 @@
|
|
|
2053
2053
|
"resource": "endUsers",
|
|
2054
2054
|
"scope": "app",
|
|
2055
2055
|
"signature": "auth.admin.app(…).endUsers.delete(userId, options?): void",
|
|
2056
|
-
"snippet": "await auth.admin.app(\"
|
|
2056
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2057
2057
|
},
|
|
2058
2058
|
"EndUserController_exportEndUsers": {
|
|
2059
2059
|
"actor": null,
|
|
@@ -2068,7 +2068,7 @@
|
|
|
2068
2068
|
"resource": "endUsers",
|
|
2069
2069
|
"scope": "app",
|
|
2070
2070
|
"signature": "auth.admin.app(…).endUsers.export(params?, options?): Response",
|
|
2071
|
-
"snippet": "const response = await auth.admin.app(\"
|
|
2071
|
+
"snippet": "const response = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.export();\nconst text = await response.text();"
|
|
2072
2072
|
},
|
|
2073
2073
|
"EndUserController_getEndUser": {
|
|
2074
2074
|
"actor": null,
|
|
@@ -2083,7 +2083,7 @@
|
|
|
2083
2083
|
"resource": "endUsers",
|
|
2084
2084
|
"scope": "app",
|
|
2085
2085
|
"signature": "auth.admin.app(…).endUsers.retrieve(userId, options?): Auth.EndUserSummary",
|
|
2086
|
-
"snippet": "const endUserSummary = await auth.admin.app(\"
|
|
2086
|
+
"snippet": "const endUserSummary = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2087
2087
|
},
|
|
2088
2088
|
"EndUserController_importEndUsers": {
|
|
2089
2089
|
"actor": null,
|
|
@@ -2098,7 +2098,7 @@
|
|
|
2098
2098
|
"resource": "endUsers.imports",
|
|
2099
2099
|
"scope": "app",
|
|
2100
2100
|
"signature": "auth.admin.app(…).endUsers.imports.create(options?): Auth.ImportJob",
|
|
2101
|
-
"snippet": "const importJob = await auth.admin.app(\"
|
|
2101
|
+
"snippet": "const importJob = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.imports.create();"
|
|
2102
2102
|
},
|
|
2103
2103
|
"EndUserController_importStatus": {
|
|
2104
2104
|
"actor": null,
|
|
@@ -2113,7 +2113,7 @@
|
|
|
2113
2113
|
"resource": "endUsers.imports",
|
|
2114
2114
|
"scope": "app",
|
|
2115
2115
|
"signature": "auth.admin.app(…).endUsers.imports.retrieve(jobId, options?): Auth.ImportJob",
|
|
2116
|
-
"snippet": "const importJob = await auth.admin.app(\"
|
|
2116
|
+
"snippet": "const importJob = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.imports.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2117
2117
|
},
|
|
2118
2118
|
"EndUserController_listContacts": {
|
|
2119
2119
|
"actor": null,
|
|
@@ -2128,7 +2128,7 @@
|
|
|
2128
2128
|
"resource": "endUsers.contacts",
|
|
2129
2129
|
"scope": "app",
|
|
2130
2130
|
"signature": "auth.admin.app(…).endUsers.contacts.list(userId, options?): Auth.AccountContactList",
|
|
2131
|
-
"snippet": "const accountContactList = await auth.admin.app(\"
|
|
2131
|
+
"snippet": "const accountContactList = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.contacts.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2132
2132
|
},
|
|
2133
2133
|
"EndUserController_listEndUsers": {
|
|
2134
2134
|
"actor": null,
|
|
@@ -2143,7 +2143,7 @@
|
|
|
2143
2143
|
"resource": "endUsers",
|
|
2144
2144
|
"scope": "app",
|
|
2145
2145
|
"signature": "auth.admin.app(…).endUsers.list(params?, options?): PagePromise<Auth.EndUserSummary>",
|
|
2146
|
-
"snippet": "for await (const endUser of auth.admin.app(\"
|
|
2146
|
+
"snippet": "for await (const endUser of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.list()) {\n console.log(endUser);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.list({}, { timeout: 5_000 });"
|
|
2147
2147
|
},
|
|
2148
2148
|
"EndUserController_promoteContact": {
|
|
2149
2149
|
"actor": null,
|
|
@@ -2158,7 +2158,7 @@
|
|
|
2158
2158
|
"resource": "endUsers.contacts",
|
|
2159
2159
|
"scope": "app",
|
|
2160
2160
|
"signature": "auth.admin.app(…).endUsers.contacts.promote(userId, contactId, options?): void",
|
|
2161
|
-
"snippet": "await auth.admin.app(\"
|
|
2161
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.contacts.promote(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2162
2162
|
},
|
|
2163
2163
|
"EndUserController_requireMfaReenrollment": {
|
|
2164
2164
|
"actor": null,
|
|
@@ -2173,7 +2173,7 @@
|
|
|
2173
2173
|
"resource": "endUsers.mfa",
|
|
2174
2174
|
"scope": "app",
|
|
2175
2175
|
"signature": "auth.admin.app(…).endUsers.mfa.requireReenrollment(userId, options?): Auth.RequireMfaReenrollment",
|
|
2176
|
-
"snippet": "const requireMfaReenrollment = await auth.admin.app(\"
|
|
2176
|
+
"snippet": "const requireMfaReenrollment = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.mfa.requireReenrollment(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2177
2177
|
},
|
|
2178
2178
|
"EndUserController_resendContactVerification": {
|
|
2179
2179
|
"actor": null,
|
|
@@ -2188,7 +2188,7 @@
|
|
|
2188
2188
|
"resource": "endUsers.contacts",
|
|
2189
2189
|
"scope": "app",
|
|
2190
2190
|
"signature": "auth.admin.app(…).endUsers.contacts.resendVerification(userId, contactId, options?): Auth.IssuedVerificationCode",
|
|
2191
|
-
"snippet": "const issuedVerificationCode = await auth.admin.app(\"
|
|
2191
|
+
"snippet": "const issuedVerificationCode = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.contacts.resendVerification(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2192
2192
|
},
|
|
2193
2193
|
"EndUserController_resendVerification": {
|
|
2194
2194
|
"actor": null,
|
|
@@ -2203,7 +2203,7 @@
|
|
|
2203
2203
|
"resource": "endUsers",
|
|
2204
2204
|
"scope": "app",
|
|
2205
2205
|
"signature": "auth.admin.app(…).endUsers.resendVerification(userId, options?): Auth.IssuedVerificationCode",
|
|
2206
|
-
"snippet": "const issuedVerificationCode = await auth.admin.app(\"
|
|
2206
|
+
"snippet": "const issuedVerificationCode = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.resendVerification(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2207
2207
|
},
|
|
2208
2208
|
"EndUserController_revokeAllSessions": {
|
|
2209
2209
|
"actor": null,
|
|
@@ -2218,7 +2218,7 @@
|
|
|
2218
2218
|
"resource": "endUsers.sessions",
|
|
2219
2219
|
"scope": "app",
|
|
2220
2220
|
"signature": "auth.admin.app(…).endUsers.sessions.revokeAll(userId, options?): void",
|
|
2221
|
-
"snippet": "await auth.admin.app(\"
|
|
2221
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.sessions.revokeAll(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2222
2222
|
},
|
|
2223
2223
|
"EndUserController_updateEndUser": {
|
|
2224
2224
|
"actor": null,
|
|
@@ -2233,7 +2233,7 @@
|
|
|
2233
2233
|
"resource": "endUsers",
|
|
2234
2234
|
"scope": "app",
|
|
2235
2235
|
"signature": "auth.admin.app(…).endUsers.update(userId, params?, options?): Auth.EndUserSummary",
|
|
2236
|
-
"snippet": "const endUserSummary = await auth.admin.app(\"
|
|
2236
|
+
"snippet": "const endUserSummary = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { display_name: \"Ada Lovelace\" });"
|
|
2237
2237
|
},
|
|
2238
2238
|
"EndUserController_updateRole": {
|
|
2239
2239
|
"actor": null,
|
|
@@ -2248,7 +2248,7 @@
|
|
|
2248
2248
|
"resource": "endUsers",
|
|
2249
2249
|
"scope": "app",
|
|
2250
2250
|
"signature": "auth.admin.app(…).endUsers.updateRole(userId, params, options?): Auth.EndUserRoleAssignment",
|
|
2251
|
-
"snippet": "const endUserRoleAssignment = await auth.admin.app(\"
|
|
2251
|
+
"snippet": "const endUserRoleAssignment = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.updateRole(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { role_name: \"admin\" });"
|
|
2252
2252
|
},
|
|
2253
2253
|
"EndUserController_updateStatus": {
|
|
2254
2254
|
"actor": null,
|
|
@@ -2263,7 +2263,7 @@
|
|
|
2263
2263
|
"resource": "endUsers",
|
|
2264
2264
|
"scope": "app",
|
|
2265
2265
|
"signature": "auth.admin.app(…).endUsers.updateStatus(userId, params, options?): Auth.EndUserSummary",
|
|
2266
|
-
"snippet": "const endUserSummary = await auth.admin.app(\"
|
|
2266
|
+
"snippet": "const endUserSummary = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.updateStatus(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { status: \"suspended\" });"
|
|
2267
2267
|
},
|
|
2268
2268
|
"EndUserInsightsController_get": {
|
|
2269
2269
|
"actor": null,
|
|
@@ -2278,7 +2278,7 @@
|
|
|
2278
2278
|
"resource": "endUserInsights",
|
|
2279
2279
|
"scope": "app",
|
|
2280
2280
|
"signature": "auth.admin.app(…).endUserInsights.retrieve(options?): Auth.EndUserInsights",
|
|
2281
|
-
"snippet": "const endUserInsights = await auth.admin.app(\"
|
|
2281
|
+
"snippet": "const endUserInsights = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUserInsights.retrieve();"
|
|
2282
2282
|
},
|
|
2283
2283
|
"EndUserInsightsController_getUser": {
|
|
2284
2284
|
"actor": null,
|
|
@@ -2293,7 +2293,7 @@
|
|
|
2293
2293
|
"resource": "endUserInsights.users",
|
|
2294
2294
|
"scope": "app",
|
|
2295
2295
|
"signature": "auth.admin.app(…).endUserInsights.users.retrieve(userId, options?): Auth.EndUserDetailInsights",
|
|
2296
|
-
"snippet": "const endUserDetailInsights = await auth.admin.app(\"
|
|
2296
|
+
"snippet": "const endUserDetailInsights = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUserInsights.users.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2297
2297
|
},
|
|
2298
2298
|
"EndUserInviteController_create": {
|
|
2299
2299
|
"actor": null,
|
|
@@ -2308,7 +2308,7 @@
|
|
|
2308
2308
|
"resource": "endUsers.invites",
|
|
2309
2309
|
"scope": "app",
|
|
2310
2310
|
"signature": "auth.admin.app(…).endUsers.invites.create(params, options?): Auth.EndUserInvite",
|
|
2311
|
-
"snippet": "const endUserInvite = await auth.admin.app(\"
|
|
2311
|
+
"snippet": "const endUserInvite = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.invites.create({ email: \"alice@example.com\" });"
|
|
2312
2312
|
},
|
|
2313
2313
|
"EndUserInviteController_list": {
|
|
2314
2314
|
"actor": null,
|
|
@@ -2323,7 +2323,7 @@
|
|
|
2323
2323
|
"resource": "endUsers.invites",
|
|
2324
2324
|
"scope": "app",
|
|
2325
2325
|
"signature": "auth.admin.app(…).endUsers.invites.list(params?, options?): PagePromise<Auth.EndUserInvite>",
|
|
2326
|
-
"snippet": "for await (const invite of auth.admin.app(\"
|
|
2326
|
+
"snippet": "for await (const invite of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.invites.list()) {\n console.log(invite);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.invites.list({}, { timeout: 5_000 });"
|
|
2327
2327
|
},
|
|
2328
2328
|
"EndUserInviteController_revoke": {
|
|
2329
2329
|
"actor": null,
|
|
@@ -2338,7 +2338,7 @@
|
|
|
2338
2338
|
"resource": "endUsers.invites",
|
|
2339
2339
|
"scope": "app",
|
|
2340
2340
|
"signature": "auth.admin.app(…).endUsers.invites.delete(inviteId, options?): void",
|
|
2341
|
-
"snippet": "await auth.admin.app(\"
|
|
2341
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").endUsers.invites.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2342
2342
|
},
|
|
2343
2343
|
"M2mController_createClient": {
|
|
2344
2344
|
"actor": null,
|
|
@@ -2353,7 +2353,7 @@
|
|
|
2353
2353
|
"resource": "credentials",
|
|
2354
2354
|
"scope": "app",
|
|
2355
2355
|
"signature": "auth.admin.app(…).credentials.create(params, options?): Auth.M2mClientCreate",
|
|
2356
|
-
"snippet": "const m2mClientCreate = await auth.admin.app(\"
|
|
2356
|
+
"snippet": "const m2mClientCreate = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").credentials.create({ name: \"CI Pipeline\" });"
|
|
2357
2357
|
},
|
|
2358
2358
|
"M2mController_deleteClient": {
|
|
2359
2359
|
"actor": null,
|
|
@@ -2368,7 +2368,7 @@
|
|
|
2368
2368
|
"resource": "credentials",
|
|
2369
2369
|
"scope": "app",
|
|
2370
2370
|
"signature": "auth.admin.app(…).credentials.delete(clientId, options?): void",
|
|
2371
|
-
"snippet": "await auth.admin.app(\"
|
|
2371
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").credentials.delete(\"m2m_a1b2c3d4e5f6\");"
|
|
2372
2372
|
},
|
|
2373
2373
|
"M2mController_getClient": {
|
|
2374
2374
|
"actor": null,
|
|
@@ -2383,7 +2383,7 @@
|
|
|
2383
2383
|
"resource": "credentials",
|
|
2384
2384
|
"scope": "app",
|
|
2385
2385
|
"signature": "auth.admin.app(…).credentials.retrieve(clientId, options?): Auth.M2mClientDetail",
|
|
2386
|
-
"snippet": "const m2mClientDetail = await auth.admin.app(\"
|
|
2386
|
+
"snippet": "const m2mClientDetail = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").credentials.retrieve(\"m2m_a1b2c3d4e5f6\");"
|
|
2387
2387
|
},
|
|
2388
2388
|
"M2mController_listClients": {
|
|
2389
2389
|
"actor": null,
|
|
@@ -2398,7 +2398,7 @@
|
|
|
2398
2398
|
"resource": "credentials",
|
|
2399
2399
|
"scope": "app",
|
|
2400
2400
|
"signature": "auth.admin.app(…).credentials.list(params?, options?): PagePromise<Auth.M2mClientSummary>",
|
|
2401
|
-
"snippet": "for await (const credential of auth.admin.app(\"
|
|
2401
|
+
"snippet": "for await (const credential of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").credentials.list()) {\n console.log(credential);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").credentials.list({}, { timeout: 5_000 });"
|
|
2402
2402
|
},
|
|
2403
2403
|
"M2mController_rotateSecret": {
|
|
2404
2404
|
"actor": null,
|
|
@@ -2413,7 +2413,7 @@
|
|
|
2413
2413
|
"resource": "credentials",
|
|
2414
2414
|
"scope": "app",
|
|
2415
2415
|
"signature": "auth.admin.app(…).credentials.rotate(clientId, options?): Auth.M2mRotateSecret",
|
|
2416
|
-
"snippet": "const m2mRotateSecret = await auth.admin.app(\"
|
|
2416
|
+
"snippet": "const m2mRotateSecret = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").credentials.rotate(\"m2m_a1b2c3d4e5f6\");"
|
|
2417
2417
|
},
|
|
2418
2418
|
"M2mController_setScopes": {
|
|
2419
2419
|
"actor": null,
|
|
@@ -2428,7 +2428,7 @@
|
|
|
2428
2428
|
"resource": "credentials",
|
|
2429
2429
|
"scope": "app",
|
|
2430
2430
|
"signature": "auth.admin.app(…).credentials.updateScopes(clientId, params, options?): Auth.CredentialUpdateScopesResponse",
|
|
2431
|
-
"snippet": "const result = await auth.admin.app(\"
|
|
2431
|
+
"snippet": "const result = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").credentials.updateScopes(\"m2m_a1b2c3d4e5f6\", { permissions: [\"user.read\", \"app.read\"] });"
|
|
2432
2432
|
},
|
|
2433
2433
|
"M2mController_updateClient": {
|
|
2434
2434
|
"actor": null,
|
|
@@ -2443,7 +2443,7 @@
|
|
|
2443
2443
|
"resource": "credentials",
|
|
2444
2444
|
"scope": "app",
|
|
2445
2445
|
"signature": "auth.admin.app(…).credentials.update(clientId, params?, options?): Auth.M2mClientDetail",
|
|
2446
|
-
"snippet": "const m2mClientDetail = await auth.admin.app(\"
|
|
2446
|
+
"snippet": "const m2mClientDetail = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").credentials.update(\"m2m_a1b2c3d4e5f6\", { is_active: true });"
|
|
2447
2447
|
},
|
|
2448
2448
|
"NotificationSettingsController_get": {
|
|
2449
2449
|
"actor": null,
|
|
@@ -2458,7 +2458,7 @@
|
|
|
2458
2458
|
"resource": "notificationSettings",
|
|
2459
2459
|
"scope": "app",
|
|
2460
2460
|
"signature": "auth.admin.app(…).notificationSettings.retrieve(options?): Auth.AppNotificationSettings",
|
|
2461
|
-
"snippet": "const appNotificationSettings = await auth.admin.app(\"
|
|
2461
|
+
"snippet": "const appNotificationSettings = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").notificationSettings.retrieve();"
|
|
2462
2462
|
},
|
|
2463
2463
|
"NotificationSettingsController_update": {
|
|
2464
2464
|
"actor": null,
|
|
@@ -2473,7 +2473,7 @@
|
|
|
2473
2473
|
"resource": "notificationSettings",
|
|
2474
2474
|
"scope": "app",
|
|
2475
2475
|
"signature": "auth.admin.app(…).notificationSettings.update(params?, options?): Auth.AppNotificationSettings",
|
|
2476
|
-
"snippet": "const appNotificationSettings = await auth.admin.app(\"
|
|
2476
|
+
"snippet": "const appNotificationSettings = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").notificationSettings.update({ default_sender_address: \"ada@example.com\" });"
|
|
2477
2477
|
},
|
|
2478
2478
|
"NotificationTestController_sendTest": {
|
|
2479
2479
|
"actor": null,
|
|
@@ -2488,7 +2488,7 @@
|
|
|
2488
2488
|
"resource": "notifications",
|
|
2489
2489
|
"scope": "app",
|
|
2490
2490
|
"signature": "auth.admin.app(…).notifications.test(slot, options?): Auth.NotificationTest",
|
|
2491
|
-
"snippet": "const notificationTest = await auth.admin.app(\"
|
|
2491
|
+
"snippet": "const notificationTest = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").notifications.test(\"verification\");"
|
|
2492
2492
|
},
|
|
2493
2493
|
"PermissionController_createPermission": {
|
|
2494
2494
|
"actor": null,
|
|
@@ -2503,7 +2503,7 @@
|
|
|
2503
2503
|
"resource": "permissions",
|
|
2504
2504
|
"scope": "app",
|
|
2505
2505
|
"signature": "auth.admin.app(…).permissions.create(params, options?): Auth.Permission",
|
|
2506
|
-
"snippet": "const permission = await auth.admin.app(\"
|
|
2506
|
+
"snippet": "const permission = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").permissions.create({ action: \"read\", resource: \"project\" });"
|
|
2507
2507
|
},
|
|
2508
2508
|
"PermissionController_deletePermission": {
|
|
2509
2509
|
"actor": null,
|
|
@@ -2518,7 +2518,7 @@
|
|
|
2518
2518
|
"resource": "permissions",
|
|
2519
2519
|
"scope": "app",
|
|
2520
2520
|
"signature": "auth.admin.app(…).permissions.delete(permissionKey, options?): void",
|
|
2521
|
-
"snippet": "await auth.admin.app(\"
|
|
2521
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").permissions.delete(\"invoice.read\");"
|
|
2522
2522
|
},
|
|
2523
2523
|
"PermissionController_listEnforcedPermissions": {
|
|
2524
2524
|
"actor": null,
|
|
@@ -2533,7 +2533,7 @@
|
|
|
2533
2533
|
"resource": "permissions.enforcement",
|
|
2534
2534
|
"scope": "app",
|
|
2535
2535
|
"signature": "auth.admin.app(…).permissions.enforcement.list(options?): Auth.EnforcedPermissions",
|
|
2536
|
-
"snippet": "const enforcedPermissions = await auth.admin.app(\"
|
|
2536
|
+
"snippet": "const enforcedPermissions = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").permissions.enforcement.list();"
|
|
2537
2537
|
},
|
|
2538
2538
|
"PermissionController_listPermissions": {
|
|
2539
2539
|
"actor": null,
|
|
@@ -2548,7 +2548,7 @@
|
|
|
2548
2548
|
"resource": "permissions",
|
|
2549
2549
|
"scope": "app",
|
|
2550
2550
|
"signature": "auth.admin.app(…).permissions.list(options?): Auth.AppScopedPermissionListResponse",
|
|
2551
|
-
"snippet": "const result = await auth.admin.app(\"
|
|
2551
|
+
"snippet": "const result = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").permissions.list();"
|
|
2552
2552
|
},
|
|
2553
2553
|
"PlatformTenantApiKeysController_getConfig": {
|
|
2554
2554
|
"actor": null,
|
|
@@ -2563,7 +2563,7 @@
|
|
|
2563
2563
|
"resource": "tenantApiKeys.config",
|
|
2564
2564
|
"scope": "app",
|
|
2565
2565
|
"signature": "auth.admin.app(…).tenantApiKeys.config.retrieve(options?): Auth.TenantApiKeysConfig",
|
|
2566
|
-
"snippet": "const tenantApiKeysConfig = await auth.admin.app(\"
|
|
2566
|
+
"snippet": "const tenantApiKeysConfig = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenantApiKeys.config.retrieve();"
|
|
2567
2567
|
},
|
|
2568
2568
|
"PlatformTenantApiKeysController_list": {
|
|
2569
2569
|
"actor": null,
|
|
@@ -2578,7 +2578,7 @@
|
|
|
2578
2578
|
"resource": "tenantApiKeys",
|
|
2579
2579
|
"scope": "app",
|
|
2580
2580
|
"signature": "auth.admin.app(…).tenantApiKeys.list(params?, options?): PagePromise<Auth.PlatformTenantApiKey>",
|
|
2581
|
-
"snippet": "for await (const tenantApiKey of auth.admin.app(\"
|
|
2581
|
+
"snippet": "for await (const tenantApiKey of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenantApiKeys.list()) {\n console.log(tenantApiKey);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenantApiKeys.list({}, { timeout: 5_000 });"
|
|
2582
2582
|
},
|
|
2583
2583
|
"PlatformTenantApiKeysController_putConfig": {
|
|
2584
2584
|
"actor": null,
|
|
@@ -2593,7 +2593,7 @@
|
|
|
2593
2593
|
"resource": "tenantApiKeys.config",
|
|
2594
2594
|
"scope": "app",
|
|
2595
2595
|
"signature": "auth.admin.app(…).tenantApiKeys.config.update(params?, options?): Auth.TenantApiKeysConfig",
|
|
2596
|
-
"snippet": "const tenantApiKeysConfig = await auth.admin.app(\"
|
|
2596
|
+
"snippet": "const tenantApiKeysConfig = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenantApiKeys.config.update({ default_expiry_days: 7 });"
|
|
2597
2597
|
},
|
|
2598
2598
|
"PlatformTenantApiKeysController_revoke": {
|
|
2599
2599
|
"actor": null,
|
|
@@ -2608,7 +2608,7 @@
|
|
|
2608
2608
|
"resource": "tenantApiKeys",
|
|
2609
2609
|
"scope": "app",
|
|
2610
2610
|
"signature": "auth.admin.app(…).tenantApiKeys.delete(keyId, options?): void",
|
|
2611
|
-
"snippet": "await auth.admin.app(\"
|
|
2611
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenantApiKeys.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2612
2612
|
},
|
|
2613
2613
|
"PlatformTenantsController_addMember": {
|
|
2614
2614
|
"actor": null,
|
|
@@ -2623,7 +2623,7 @@
|
|
|
2623
2623
|
"resource": "tenants.members",
|
|
2624
2624
|
"scope": "app",
|
|
2625
2625
|
"signature": "auth.admin.app(…).tenants.members.create(tenantId, params, options?): Auth.AddMember",
|
|
2626
|
-
"snippet": "const addMember = await auth.admin.app(\"
|
|
2626
|
+
"snippet": "const addMember = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.members.create(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { role_name: \"member\" });"
|
|
2627
2627
|
},
|
|
2628
2628
|
"PlatformTenantsController_create": {
|
|
2629
2629
|
"actor": null,
|
|
@@ -2638,7 +2638,7 @@
|
|
|
2638
2638
|
"resource": "tenants",
|
|
2639
2639
|
"scope": "app",
|
|
2640
2640
|
"signature": "auth.admin.app(…).tenants.create(params, options?): Auth.Tenant",
|
|
2641
|
-
"snippet": "const tenant = await auth.admin.app(\"
|
|
2641
|
+
"snippet": "const tenant = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.create({ display_name: \"Acme Co\" });"
|
|
2642
2642
|
},
|
|
2643
2643
|
"PlatformTenantsController_createInvite": {
|
|
2644
2644
|
"actor": null,
|
|
@@ -2653,7 +2653,7 @@
|
|
|
2653
2653
|
"resource": "tenants.invites",
|
|
2654
2654
|
"scope": "app",
|
|
2655
2655
|
"signature": "auth.admin.app(…).tenants.invites.create(tenantId, params, options?): Auth.CreateTenantInvite",
|
|
2656
|
-
"snippet": "const createTenantInvite = await auth.admin.app(\"
|
|
2656
|
+
"snippet": "const createTenantInvite = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.invites.create(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { email: \"alice@example.com\", role_name: \"member\" });"
|
|
2657
2657
|
},
|
|
2658
2658
|
"PlatformTenantsController_delete": {
|
|
2659
2659
|
"actor": null,
|
|
@@ -2668,7 +2668,7 @@
|
|
|
2668
2668
|
"resource": "tenants",
|
|
2669
2669
|
"scope": "app",
|
|
2670
2670
|
"signature": "auth.admin.app(…).tenants.delete(tenantId, options?): void",
|
|
2671
|
-
"snippet": "await auth.admin.app(\"
|
|
2671
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2672
2672
|
},
|
|
2673
2673
|
"PlatformTenantsController_get": {
|
|
2674
2674
|
"actor": null,
|
|
@@ -2683,7 +2683,7 @@
|
|
|
2683
2683
|
"resource": "tenants",
|
|
2684
2684
|
"scope": "app",
|
|
2685
2685
|
"signature": "auth.admin.app(…).tenants.retrieve(tenantId, options?): Auth.Tenant",
|
|
2686
|
-
"snippet": "const tenant = await auth.admin.app(\"
|
|
2686
|
+
"snippet": "const tenant = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2687
2687
|
},
|
|
2688
2688
|
"PlatformTenantsController_list": {
|
|
2689
2689
|
"actor": null,
|
|
@@ -2698,7 +2698,7 @@
|
|
|
2698
2698
|
"resource": "tenants",
|
|
2699
2699
|
"scope": "app",
|
|
2700
2700
|
"signature": "auth.admin.app(…).tenants.list(params?, options?): PagePromise<Auth.Tenant>",
|
|
2701
|
-
"snippet": "for await (const tenant of auth.admin.app(\"
|
|
2701
|
+
"snippet": "for await (const tenant of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.list()) {\n console.log(tenant);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.list({}, { timeout: 5_000 });"
|
|
2702
2702
|
},
|
|
2703
2703
|
"PlatformTenantsController_listInvites": {
|
|
2704
2704
|
"actor": null,
|
|
@@ -2713,7 +2713,7 @@
|
|
|
2713
2713
|
"resource": "tenants.invites",
|
|
2714
2714
|
"scope": "app",
|
|
2715
2715
|
"signature": "auth.admin.app(…).tenants.invites.list(tenantId, params?, options?): PagePromise<Auth.TenantInvite>",
|
|
2716
|
-
"snippet": "for await (const invite of auth.admin.app(\"
|
|
2716
|
+
"snippet": "for await (const invite of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.invites.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\")) {\n console.log(invite);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.invites.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", {}, { timeout: 5_000 });"
|
|
2717
2717
|
},
|
|
2718
2718
|
"PlatformTenantsController_listMembers": {
|
|
2719
2719
|
"actor": null,
|
|
@@ -2728,7 +2728,7 @@
|
|
|
2728
2728
|
"resource": "tenants.members",
|
|
2729
2729
|
"scope": "app",
|
|
2730
2730
|
"signature": "auth.admin.app(…).tenants.members.list(tenantId, params?, options?): PagePromise<Auth.TenantMembership>",
|
|
2731
|
-
"snippet": "for await (const member of auth.admin.app(\"
|
|
2731
|
+
"snippet": "for await (const member of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.members.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\")) {\n console.log(member);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.members.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", {}, { timeout: 5_000 });"
|
|
2732
2732
|
},
|
|
2733
2733
|
"PlatformTenantsController_removeMember": {
|
|
2734
2734
|
"actor": null,
|
|
@@ -2743,7 +2743,7 @@
|
|
|
2743
2743
|
"resource": "tenants.members",
|
|
2744
2744
|
"scope": "app",
|
|
2745
2745
|
"signature": "auth.admin.app(…).tenants.members.delete(tenantId, accountId, options?): void",
|
|
2746
|
-
"snippet": "await auth.admin.app(\"
|
|
2746
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.members.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2747
2747
|
},
|
|
2748
2748
|
"PlatformTenantsController_revokeInvite": {
|
|
2749
2749
|
"actor": null,
|
|
@@ -2758,7 +2758,7 @@
|
|
|
2758
2758
|
"resource": "tenants.invites",
|
|
2759
2759
|
"scope": "app",
|
|
2760
2760
|
"signature": "auth.admin.app(…).tenants.invites.delete(tenantId, inviteId, options?): void",
|
|
2761
|
-
"snippet": "await auth.admin.app(\"
|
|
2761
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.invites.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2762
2762
|
},
|
|
2763
2763
|
"PlatformTenantsController_update": {
|
|
2764
2764
|
"actor": null,
|
|
@@ -2773,7 +2773,7 @@
|
|
|
2773
2773
|
"resource": "tenants",
|
|
2774
2774
|
"scope": "app",
|
|
2775
2775
|
"signature": "auth.admin.app(…).tenants.update(tenantId, params?, options?): Auth.Tenant",
|
|
2776
|
-
"snippet": "const tenant = await auth.admin.app(\"
|
|
2776
|
+
"snippet": "const tenant = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { display_name: \"Acme Inc\" });"
|
|
2777
2777
|
},
|
|
2778
2778
|
"PlatformTenantsController_updateMemberRole": {
|
|
2779
2779
|
"actor": null,
|
|
@@ -2788,7 +2788,7 @@
|
|
|
2788
2788
|
"resource": "tenants.members",
|
|
2789
2789
|
"scope": "app",
|
|
2790
2790
|
"signature": "auth.admin.app(…).tenants.members.update(tenantId, accountId, params, options?): Auth.TenantMembership",
|
|
2791
|
-
"snippet": "const tenantMembership = await auth.admin.app(\"
|
|
2791
|
+
"snippet": "const tenantMembership = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").tenants.members.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { role_name: \"admin\" });"
|
|
2792
2792
|
},
|
|
2793
2793
|
"RoleController_assignRole": {
|
|
2794
2794
|
"actor": null,
|
|
@@ -2803,7 +2803,7 @@
|
|
|
2803
2803
|
"resource": "roles",
|
|
2804
2804
|
"scope": "app",
|
|
2805
2805
|
"signature": "auth.admin.app(…).roles.assign(params, options?): Auth.AppMembership",
|
|
2806
|
-
"snippet": "const appMembership = await auth.admin.app(\"
|
|
2806
|
+
"snippet": "const appMembership = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").roles.assign({ account_id: \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", role: \"admin\" });"
|
|
2807
2807
|
},
|
|
2808
2808
|
"RoleController_createRole": {
|
|
2809
2809
|
"actor": null,
|
|
@@ -2818,7 +2818,7 @@
|
|
|
2818
2818
|
"resource": "roles",
|
|
2819
2819
|
"scope": "app",
|
|
2820
2820
|
"signature": "auth.admin.app(…).roles.create(params, options?): Auth.Role",
|
|
2821
|
-
"snippet": "const role = await auth.admin.app(\"
|
|
2821
|
+
"snippet": "const role = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").roles.create({ name: \"editor\" });"
|
|
2822
2822
|
},
|
|
2823
2823
|
"RoleController_deleteRole": {
|
|
2824
2824
|
"actor": null,
|
|
@@ -2833,7 +2833,7 @@
|
|
|
2833
2833
|
"resource": "roles",
|
|
2834
2834
|
"scope": "app",
|
|
2835
2835
|
"signature": "auth.admin.app(…).roles.delete(roleName, options?): void",
|
|
2836
|
-
"snippet": "await auth.admin.app(\"
|
|
2836
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").roles.delete(\"admin\");"
|
|
2837
2837
|
},
|
|
2838
2838
|
"RoleController_getRole": {
|
|
2839
2839
|
"actor": null,
|
|
@@ -2848,7 +2848,7 @@
|
|
|
2848
2848
|
"resource": "roles",
|
|
2849
2849
|
"scope": "app",
|
|
2850
2850
|
"signature": "auth.admin.app(…).roles.retrieve(roleName, options?): Auth.RoleWithPermissions",
|
|
2851
|
-
"snippet": "const roleWithPermissions = await auth.admin.app(\"
|
|
2851
|
+
"snippet": "const roleWithPermissions = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").roles.retrieve(\"admin\");"
|
|
2852
2852
|
},
|
|
2853
2853
|
"RoleController_listPermissions": {
|
|
2854
2854
|
"actor": null,
|
|
@@ -2863,7 +2863,7 @@
|
|
|
2863
2863
|
"resource": "roles.permissions",
|
|
2864
2864
|
"scope": "app",
|
|
2865
2865
|
"signature": "auth.admin.app(…).roles.permissions.list(options?): Auth.RolePermissionListResponse",
|
|
2866
|
-
"snippet": "const result = await auth.admin.app(\"
|
|
2866
|
+
"snippet": "const result = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").roles.permissions.list();"
|
|
2867
2867
|
},
|
|
2868
2868
|
"RoleController_listRoles": {
|
|
2869
2869
|
"actor": null,
|
|
@@ -2878,7 +2878,7 @@
|
|
|
2878
2878
|
"resource": "roles",
|
|
2879
2879
|
"scope": "app",
|
|
2880
2880
|
"signature": "auth.admin.app(…).roles.list(params?, options?): PagePromise<Auth.Role>",
|
|
2881
|
-
"snippet": "for await (const role of auth.admin.app(\"
|
|
2881
|
+
"snippet": "for await (const role of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").roles.list()) {\n console.log(role);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").roles.list({}, { timeout: 5_000 });"
|
|
2882
2882
|
},
|
|
2883
2883
|
"RoleController_setPermissions": {
|
|
2884
2884
|
"actor": null,
|
|
@@ -2893,7 +2893,7 @@
|
|
|
2893
2893
|
"resource": "roles",
|
|
2894
2894
|
"scope": "app",
|
|
2895
2895
|
"signature": "auth.admin.app(…).roles.updatePermissions(roleName, params, options?): Auth.AppScopedRoleUpdatePermissionsResponse",
|
|
2896
|
-
"snippet": "const result = await auth.admin.app(\"
|
|
2896
|
+
"snippet": "const result = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").roles.updatePermissions(\"admin\", { permissions: [\"user.read\", \"role.create\"] });"
|
|
2897
2897
|
},
|
|
2898
2898
|
"RoleController_updateRole": {
|
|
2899
2899
|
"actor": null,
|
|
@@ -2908,7 +2908,7 @@
|
|
|
2908
2908
|
"resource": "roles",
|
|
2909
2909
|
"scope": "app",
|
|
2910
2910
|
"signature": "auth.admin.app(…).roles.update(roleName, params?, options?): Auth.Role",
|
|
2911
|
-
"snippet": "const role = await auth.admin.app(\"
|
|
2911
|
+
"snippet": "const role = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").roles.update(\"admin\", { description: \"Updated description\" });"
|
|
2912
2912
|
},
|
|
2913
2913
|
"SetupStatusController_get": {
|
|
2914
2914
|
"actor": null,
|
|
@@ -2923,7 +2923,7 @@
|
|
|
2923
2923
|
"resource": "setupStatus",
|
|
2924
2924
|
"scope": "app",
|
|
2925
2925
|
"signature": "auth.admin.app(…).setupStatus.retrieve(options?): Auth.SetupStatus",
|
|
2926
|
-
"snippet": "const setupStatus = await auth.admin.app(\"
|
|
2926
|
+
"snippet": "const setupStatus = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").setupStatus.retrieve();"
|
|
2927
2927
|
},
|
|
2928
2928
|
"SignInTestController_create": {
|
|
2929
2929
|
"actor": null,
|
|
@@ -2938,7 +2938,7 @@
|
|
|
2938
2938
|
"resource": "signInTests",
|
|
2939
2939
|
"scope": "app",
|
|
2940
2940
|
"signature": "auth.admin.app(…).signInTests.create(params, options?): Auth.SignInTest",
|
|
2941
|
-
"snippet": "const signInTest = await auth.admin.app(\"
|
|
2941
|
+
"snippet": "const signInTest = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").signInTests.create({ method: \"oauth\" });"
|
|
2942
2942
|
},
|
|
2943
2943
|
"SignInTestController_get": {
|
|
2944
2944
|
"actor": null,
|
|
@@ -2953,7 +2953,7 @@
|
|
|
2953
2953
|
"resource": "signInTests",
|
|
2954
2954
|
"scope": "app",
|
|
2955
2955
|
"signature": "auth.admin.app(…).signInTests.retrieve(testId, options?): Auth.SignInTest",
|
|
2956
|
-
"snippet": "const signInTest = await auth.admin.app(\"
|
|
2956
|
+
"snippet": "const signInTest = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").signInTests.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
2957
2957
|
},
|
|
2958
2958
|
"StatsController_getMyStats": {
|
|
2959
2959
|
"actor": null,
|
|
@@ -2983,7 +2983,7 @@
|
|
|
2983
2983
|
"resource": "unverifiedAccountExpiry",
|
|
2984
2984
|
"scope": "app",
|
|
2985
2985
|
"signature": "auth.admin.app(…).unverifiedAccountExpiry.run(params?, options?): Auth.UnverifiedAccountExpiryRun",
|
|
2986
|
-
"snippet": "const unverifiedAccountExpiryRun = await auth.admin.app(\"
|
|
2986
|
+
"snippet": "const unverifiedAccountExpiryRun = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").unverifiedAccountExpiry.run({ dry_run: false });"
|
|
2987
2987
|
},
|
|
2988
2988
|
"UnverifiedAccountExpiryController_status": {
|
|
2989
2989
|
"actor": null,
|
|
@@ -2998,7 +2998,7 @@
|
|
|
2998
2998
|
"resource": "unverifiedAccountExpiry",
|
|
2999
2999
|
"scope": "app",
|
|
3000
3000
|
"signature": "auth.admin.app(…).unverifiedAccountExpiry.retrieve(options?): Auth.UnverifiedAccountExpiryStatus",
|
|
3001
|
-
"snippet": "const unverifiedAccountExpiryStatus = await auth.admin.app(\"
|
|
3001
|
+
"snippet": "const unverifiedAccountExpiryStatus = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").unverifiedAccountExpiry.retrieve();"
|
|
3002
3002
|
},
|
|
3003
3003
|
"WebauthnConfigController_get": {
|
|
3004
3004
|
"actor": null,
|
|
@@ -3013,7 +3013,7 @@
|
|
|
3013
3013
|
"resource": "webauthnConfig",
|
|
3014
3014
|
"scope": "app",
|
|
3015
3015
|
"signature": "auth.admin.app(…).webauthnConfig.retrieve(options?): Auth.WebauthnConfig",
|
|
3016
|
-
"snippet": "const webauthnConfig = await auth.admin.app(\"
|
|
3016
|
+
"snippet": "const webauthnConfig = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webauthnConfig.retrieve();"
|
|
3017
3017
|
},
|
|
3018
3018
|
"WebauthnConfigController_put": {
|
|
3019
3019
|
"actor": null,
|
|
@@ -3028,7 +3028,7 @@
|
|
|
3028
3028
|
"resource": "webauthnConfig",
|
|
3029
3029
|
"scope": "app",
|
|
3030
3030
|
"signature": "auth.admin.app(…).webauthnConfig.update(params, options?): Auth.WebauthnConfig",
|
|
3031
|
-
"snippet": "const webauthnConfig = await auth.admin.app(\"
|
|
3031
|
+
"snippet": "const webauthnConfig = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webauthnConfig.update({ enabled: true, rp_id: \"example.com\" });"
|
|
3032
3032
|
},
|
|
3033
3033
|
"WebhooksController_auth_app_createEndpoint": {
|
|
3034
3034
|
"actor": null,
|
|
@@ -3043,7 +3043,7 @@
|
|
|
3043
3043
|
"resource": "webhooks.endpoints",
|
|
3044
3044
|
"scope": "app",
|
|
3045
3045
|
"signature": "auth.admin.app(…).webhooks.endpoints.create(params, options?): Auth.WebhookEndpointWithSecret",
|
|
3046
|
-
"snippet": "const webhookEndpointWithSecret = await auth.admin.app(\"
|
|
3046
|
+
"snippet": "const webhookEndpointWithSecret = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.endpoints.create({ url: \"https://api.acme.com/webhooks\" });"
|
|
3047
3047
|
},
|
|
3048
3048
|
"WebhooksController_auth_app_deleteEndpoint": {
|
|
3049
3049
|
"actor": null,
|
|
@@ -3058,7 +3058,7 @@
|
|
|
3058
3058
|
"resource": "webhooks.endpoints",
|
|
3059
3059
|
"scope": "app",
|
|
3060
3060
|
"signature": "auth.admin.app(…).webhooks.endpoints.delete(endpointId, options?): void",
|
|
3061
|
-
"snippet": "await auth.admin.app(\"
|
|
3061
|
+
"snippet": "await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.endpoints.delete(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
3062
3062
|
},
|
|
3063
3063
|
"WebhooksController_auth_app_getEndpoint": {
|
|
3064
3064
|
"actor": null,
|
|
@@ -3073,7 +3073,7 @@
|
|
|
3073
3073
|
"resource": "webhooks.endpoints",
|
|
3074
3074
|
"scope": "app",
|
|
3075
3075
|
"signature": "auth.admin.app(…).webhooks.endpoints.retrieve(endpointId, options?): Auth.WebhookEndpoint",
|
|
3076
|
-
"snippet": "const webhookEndpoint = await auth.admin.app(\"
|
|
3076
|
+
"snippet": "const webhookEndpoint = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.endpoints.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
3077
3077
|
},
|
|
3078
3078
|
"WebhooksController_auth_app_getEvent": {
|
|
3079
3079
|
"actor": null,
|
|
@@ -3088,7 +3088,7 @@
|
|
|
3088
3088
|
"resource": "webhooks.events",
|
|
3089
3089
|
"scope": "app",
|
|
3090
3090
|
"signature": "auth.admin.app(…).webhooks.events.retrieve(eventId, options?): Auth.WebhookEventDetail",
|
|
3091
|
-
"snippet": "const webhookEventDetail = await auth.admin.app(\"
|
|
3091
|
+
"snippet": "const webhookEventDetail = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.events.retrieve(\"evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
3092
3092
|
},
|
|
3093
3093
|
"WebhooksController_auth_app_listEndpoints": {
|
|
3094
3094
|
"actor": null,
|
|
@@ -3103,7 +3103,7 @@
|
|
|
3103
3103
|
"resource": "webhooks.endpoints",
|
|
3104
3104
|
"scope": "app",
|
|
3105
3105
|
"signature": "auth.admin.app(…).webhooks.endpoints.list(options?): PagePromise<Auth.WebhookEndpoint>",
|
|
3106
|
-
"snippet": "for await (const endpoint of auth.admin.app(\"
|
|
3106
|
+
"snippet": "for await (const endpoint of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.endpoints.list()) {\n console.log(endpoint);\n}"
|
|
3107
3107
|
},
|
|
3108
3108
|
"WebhooksController_auth_app_listEventTypes": {
|
|
3109
3109
|
"actor": null,
|
|
@@ -3118,7 +3118,7 @@
|
|
|
3118
3118
|
"resource": "webhooks.eventTypes",
|
|
3119
3119
|
"scope": "app",
|
|
3120
3120
|
"signature": "auth.admin.app(…).webhooks.eventTypes.list(options?): Auth.ListWebhookEventTypes",
|
|
3121
|
-
"snippet": "const listWebhookEventTypes = await auth.admin.app(\"
|
|
3121
|
+
"snippet": "const listWebhookEventTypes = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.eventTypes.list();"
|
|
3122
3122
|
},
|
|
3123
3123
|
"WebhooksController_auth_app_listEvents": {
|
|
3124
3124
|
"actor": null,
|
|
@@ -3133,7 +3133,7 @@
|
|
|
3133
3133
|
"resource": "webhooks.events",
|
|
3134
3134
|
"scope": "app",
|
|
3135
3135
|
"signature": "auth.admin.app(…).webhooks.events.list(params?, options?): PagePromise<Auth.WebhookEvent>",
|
|
3136
|
-
"snippet": "for await (const event of auth.admin.app(\"
|
|
3136
|
+
"snippet": "for await (const event of auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.events.list()) {\n console.log(event);\n}\nconst page = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.events.list({}, { timeout: 5_000 });"
|
|
3137
3137
|
},
|
|
3138
3138
|
"WebhooksController_auth_app_replay": {
|
|
3139
3139
|
"actor": null,
|
|
@@ -3148,7 +3148,7 @@
|
|
|
3148
3148
|
"resource": "webhooks.events",
|
|
3149
3149
|
"scope": "app",
|
|
3150
3150
|
"signature": "auth.admin.app(…).webhooks.events.replay(eventId, params?, options?): Auth.ReplayWebhookEvent",
|
|
3151
|
-
"snippet": "const replayWebhookEvent = await auth.admin.app(\"
|
|
3151
|
+
"snippet": "const replayWebhookEvent = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.events.replay(\"evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
|
|
3152
3152
|
},
|
|
3153
3153
|
"WebhooksController_auth_app_rotateSecret": {
|
|
3154
3154
|
"actor": null,
|
|
@@ -3163,7 +3163,7 @@
|
|
|
3163
3163
|
"resource": "webhooks.endpoints",
|
|
3164
3164
|
"scope": "app",
|
|
3165
3165
|
"signature": "auth.admin.app(…).webhooks.endpoints.rotateSecret(endpointId, params?, options?): Auth.WebhookEndpointWithSecret",
|
|
3166
|
-
"snippet": "const webhookEndpointWithSecret = await auth.admin.app(\"
|
|
3166
|
+
"snippet": "const webhookEndpointWithSecret = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.endpoints.rotateSecret(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { grace_hours: 24 });"
|
|
3167
3167
|
},
|
|
3168
3168
|
"WebhooksController_auth_app_sendTest": {
|
|
3169
3169
|
"actor": null,
|
|
@@ -3178,7 +3178,7 @@
|
|
|
3178
3178
|
"resource": "webhooks.endpoints",
|
|
3179
3179
|
"scope": "app",
|
|
3180
3180
|
"signature": "auth.admin.app(…).webhooks.endpoints.test(endpointId, params, options?): Auth.WebhookDeliveryAttempt",
|
|
3181
|
-
"snippet": "const webhookDeliveryAttempt = await auth.admin.app(\"
|
|
3181
|
+
"snippet": "const webhookDeliveryAttempt = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.endpoints.test(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { event_type: \"user.signup\" });"
|
|
3182
3182
|
},
|
|
3183
3183
|
"WebhooksController_auth_app_updateEndpoint": {
|
|
3184
3184
|
"actor": null,
|
|
@@ -3193,7 +3193,7 @@
|
|
|
3193
3193
|
"resource": "webhooks.endpoints",
|
|
3194
3194
|
"scope": "app",
|
|
3195
3195
|
"signature": "auth.admin.app(…).webhooks.endpoints.update(endpointId, params?, options?): Auth.WebhookEndpoint",
|
|
3196
|
-
"snippet": "const webhookEndpoint = await auth.admin.app(\"
|
|
3196
|
+
"snippet": "const webhookEndpoint = await auth.admin.app(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\").webhooks.endpoints.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { description: \"Production receiver\" });"
|
|
3197
3197
|
},
|
|
3198
3198
|
"WorkspaceStatsController_get": {
|
|
3199
3199
|
"actor": null,
|