@productcraft/platform-auth 0.1.3 → 1.0.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 +118 -212
- package/api.md +1716 -0
- package/dist/index.cjs +1809 -7
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +4082 -260
- package/dist/index.d.ts +4082 -260
- package/dist/index.js +1744 -8
- package/dist/index.js.map +1 -1
- package/dist/testing.cjs +691 -0
- package/dist/testing.cjs.map +1 -0
- package/dist/testing.d.cts +32 -0
- package/dist/testing.d.ts +32 -0
- package/dist/testing.js +689 -0
- package/dist/testing.js.map +1 -0
- package/manifest.json +1115 -0
- package/package.json +15 -5
package/manifest.json
ADDED
|
@@ -0,0 +1,1115 @@
|
|
|
1
|
+
{
|
|
2
|
+
"operations": {
|
|
3
|
+
"AccountController_deleteAccount": {
|
|
4
|
+
"actor": null,
|
|
5
|
+
"deprecated": false,
|
|
6
|
+
"http": "DELETE /v1/account",
|
|
7
|
+
"idempotent": false,
|
|
8
|
+
"method": "erase",
|
|
9
|
+
"paginated": false,
|
|
10
|
+
"params": null,
|
|
11
|
+
"poll": null,
|
|
12
|
+
"public": false,
|
|
13
|
+
"resource": "account",
|
|
14
|
+
"scope": null,
|
|
15
|
+
"signature": "platform.account.erase(options?): void",
|
|
16
|
+
"snippet": "await platform.account.erase();"
|
|
17
|
+
},
|
|
18
|
+
"ApiKeySelfController_self": {
|
|
19
|
+
"actor": null,
|
|
20
|
+
"deprecated": false,
|
|
21
|
+
"http": "GET /v1/api-keys/self",
|
|
22
|
+
"idempotent": false,
|
|
23
|
+
"method": "self",
|
|
24
|
+
"paginated": false,
|
|
25
|
+
"params": null,
|
|
26
|
+
"poll": null,
|
|
27
|
+
"public": false,
|
|
28
|
+
"resource": "apiKeys",
|
|
29
|
+
"scope": null,
|
|
30
|
+
"signature": "platform.apiKeys.self(options?): PlatformAuth.ApiKeySelf",
|
|
31
|
+
"snippet": "const apiKeySelf = await platform.apiKeys.self();"
|
|
32
|
+
},
|
|
33
|
+
"AuthenticationController_logout": {
|
|
34
|
+
"actor": null,
|
|
35
|
+
"deprecated": false,
|
|
36
|
+
"http": "POST /v1/auth/logout",
|
|
37
|
+
"idempotent": false,
|
|
38
|
+
"method": "logout",
|
|
39
|
+
"paginated": false,
|
|
40
|
+
"params": "PlatformAuth.AuthLogoutParams",
|
|
41
|
+
"poll": null,
|
|
42
|
+
"public": true,
|
|
43
|
+
"resource": "auth",
|
|
44
|
+
"scope": null,
|
|
45
|
+
"signature": "platform.auth.logout(params, options?): void",
|
|
46
|
+
"snippet": "await platform.auth.logout({ refresh_token: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\" });"
|
|
47
|
+
},
|
|
48
|
+
"AuthenticationController_logoutCurrent": {
|
|
49
|
+
"actor": null,
|
|
50
|
+
"deprecated": false,
|
|
51
|
+
"http": "POST /v1/auth/logout-current",
|
|
52
|
+
"idempotent": false,
|
|
53
|
+
"method": "logoutCurrent",
|
|
54
|
+
"paginated": false,
|
|
55
|
+
"params": null,
|
|
56
|
+
"poll": null,
|
|
57
|
+
"public": false,
|
|
58
|
+
"resource": "auth",
|
|
59
|
+
"scope": null,
|
|
60
|
+
"signature": "platform.auth.logoutCurrent(options?): void",
|
|
61
|
+
"snippet": "await platform.auth.logoutCurrent();"
|
|
62
|
+
},
|
|
63
|
+
"AuthenticationController_refresh": {
|
|
64
|
+
"actor": null,
|
|
65
|
+
"deprecated": false,
|
|
66
|
+
"http": "POST /v1/auth/refresh",
|
|
67
|
+
"idempotent": false,
|
|
68
|
+
"method": "refresh",
|
|
69
|
+
"paginated": false,
|
|
70
|
+
"params": "PlatformAuth.AuthRefreshParams",
|
|
71
|
+
"poll": null,
|
|
72
|
+
"public": true,
|
|
73
|
+
"resource": "auth",
|
|
74
|
+
"scope": null,
|
|
75
|
+
"signature": "platform.auth.refresh(params, options?): PlatformAuth.Token",
|
|
76
|
+
"snippet": "const token = await platform.auth.refresh({ refresh_token: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\" });"
|
|
77
|
+
},
|
|
78
|
+
"AuthenticationController_signin": {
|
|
79
|
+
"actor": null,
|
|
80
|
+
"deprecated": false,
|
|
81
|
+
"http": "POST /v1/auth/signin",
|
|
82
|
+
"idempotent": false,
|
|
83
|
+
"method": "signin",
|
|
84
|
+
"paginated": false,
|
|
85
|
+
"params": "PlatformAuth.AuthSigninParams",
|
|
86
|
+
"poll": null,
|
|
87
|
+
"public": true,
|
|
88
|
+
"resource": "auth",
|
|
89
|
+
"scope": null,
|
|
90
|
+
"signature": "platform.auth.signin(params, options?): PlatformAuth.Token",
|
|
91
|
+
"snippet": "const token = await platform.auth.signin({ identifier: \"user@example.com\", password: \"MySecurePassword123\" });"
|
|
92
|
+
},
|
|
93
|
+
"AuthenticationController_signup": {
|
|
94
|
+
"actor": null,
|
|
95
|
+
"deprecated": false,
|
|
96
|
+
"http": "POST /v1/auth/signup",
|
|
97
|
+
"idempotent": false,
|
|
98
|
+
"method": "signup",
|
|
99
|
+
"paginated": false,
|
|
100
|
+
"params": "PlatformAuth.AuthSignupParams",
|
|
101
|
+
"poll": null,
|
|
102
|
+
"public": true,
|
|
103
|
+
"resource": "auth",
|
|
104
|
+
"scope": null,
|
|
105
|
+
"signature": "platform.auth.signup(params, options?): PlatformAuth.Token",
|
|
106
|
+
"snippet": "const token = await platform.auth.signup({ email: \"user@example.com\", password: \"MySecurePassword123\", username: \"john_doe\" });"
|
|
107
|
+
},
|
|
108
|
+
"AuthorizationServerMetadataController_metadata": {
|
|
109
|
+
"actor": null,
|
|
110
|
+
"deprecated": false,
|
|
111
|
+
"http": "GET /.well-known/oauth-authorization-server",
|
|
112
|
+
"idempotent": false,
|
|
113
|
+
"method": "oauthAuthorizationServer",
|
|
114
|
+
"paginated": false,
|
|
115
|
+
"params": null,
|
|
116
|
+
"poll": null,
|
|
117
|
+
"public": true,
|
|
118
|
+
"resource": "wellKnown",
|
|
119
|
+
"scope": null,
|
|
120
|
+
"signature": "platform.wellKnown.oauthAuthorizationServer(options?): PlatformAuth.AuthorizationServerMetadata",
|
|
121
|
+
"snippet": "const authorizationServerMetadata = await platform.wellKnown.oauthAuthorizationServer();"
|
|
122
|
+
},
|
|
123
|
+
"HiddenGuidesController_hide": {
|
|
124
|
+
"actor": null,
|
|
125
|
+
"deprecated": false,
|
|
126
|
+
"http": "PUT /v1/me/hidden-guides/{key}",
|
|
127
|
+
"idempotent": false,
|
|
128
|
+
"method": "hide",
|
|
129
|
+
"paginated": false,
|
|
130
|
+
"params": null,
|
|
131
|
+
"poll": null,
|
|
132
|
+
"public": false,
|
|
133
|
+
"resource": "me.hiddenGuides",
|
|
134
|
+
"scope": null,
|
|
135
|
+
"signature": "platform.me.hiddenGuides.hide(key, options?): PlatformAuth.HiddenGuide",
|
|
136
|
+
"snippet": "const hiddenGuide = await platform.me.hiddenGuides.hide(\"key\");"
|
|
137
|
+
},
|
|
138
|
+
"HiddenGuidesController_list": {
|
|
139
|
+
"actor": null,
|
|
140
|
+
"deprecated": false,
|
|
141
|
+
"http": "GET /v1/me/hidden-guides",
|
|
142
|
+
"idempotent": false,
|
|
143
|
+
"method": "list",
|
|
144
|
+
"paginated": false,
|
|
145
|
+
"params": null,
|
|
146
|
+
"poll": null,
|
|
147
|
+
"public": false,
|
|
148
|
+
"resource": "me.hiddenGuides",
|
|
149
|
+
"scope": null,
|
|
150
|
+
"signature": "platform.me.hiddenGuides.list(options?): PlatformAuth.HiddenGuides",
|
|
151
|
+
"snippet": "const hiddenGuides = await platform.me.hiddenGuides.list();"
|
|
152
|
+
},
|
|
153
|
+
"HiddenGuidesController_show": {
|
|
154
|
+
"actor": null,
|
|
155
|
+
"deprecated": false,
|
|
156
|
+
"http": "DELETE /v1/me/hidden-guides/{key}",
|
|
157
|
+
"idempotent": false,
|
|
158
|
+
"method": "unhide",
|
|
159
|
+
"paginated": false,
|
|
160
|
+
"params": null,
|
|
161
|
+
"poll": null,
|
|
162
|
+
"public": false,
|
|
163
|
+
"resource": "me.hiddenGuides",
|
|
164
|
+
"scope": null,
|
|
165
|
+
"signature": "platform.me.hiddenGuides.unhide(key, options?): void",
|
|
166
|
+
"snippet": "await platform.me.hiddenGuides.unhide(\"key\");"
|
|
167
|
+
},
|
|
168
|
+
"HiddenGuidesController_showAll": {
|
|
169
|
+
"actor": null,
|
|
170
|
+
"deprecated": false,
|
|
171
|
+
"http": "DELETE /v1/me/hidden-guides",
|
|
172
|
+
"idempotent": false,
|
|
173
|
+
"method": "reset",
|
|
174
|
+
"paginated": false,
|
|
175
|
+
"params": null,
|
|
176
|
+
"poll": null,
|
|
177
|
+
"public": false,
|
|
178
|
+
"resource": "me.hiddenGuides",
|
|
179
|
+
"scope": null,
|
|
180
|
+
"signature": "platform.me.hiddenGuides.reset(options?): void",
|
|
181
|
+
"snippet": "await platform.me.hiddenGuides.reset();"
|
|
182
|
+
},
|
|
183
|
+
"IntrospectController_introspect": {
|
|
184
|
+
"actor": null,
|
|
185
|
+
"deprecated": false,
|
|
186
|
+
"http": "GET /v1/introspect",
|
|
187
|
+
"idempotent": false,
|
|
188
|
+
"method": "retrieve",
|
|
189
|
+
"paginated": false,
|
|
190
|
+
"params": null,
|
|
191
|
+
"poll": null,
|
|
192
|
+
"public": false,
|
|
193
|
+
"resource": "introspect",
|
|
194
|
+
"scope": null,
|
|
195
|
+
"signature": "platform.introspect.retrieve(options?): PlatformAuth.Introspect",
|
|
196
|
+
"snippet": "const introspect = await platform.introspect.retrieve();"
|
|
197
|
+
},
|
|
198
|
+
"IntrospectController_introspectApiKey": {
|
|
199
|
+
"actor": null,
|
|
200
|
+
"deprecated": false,
|
|
201
|
+
"http": "POST /v1/introspect/api-key",
|
|
202
|
+
"idempotent": false,
|
|
203
|
+
"method": "apiKey",
|
|
204
|
+
"paginated": false,
|
|
205
|
+
"params": null,
|
|
206
|
+
"poll": null,
|
|
207
|
+
"public": false,
|
|
208
|
+
"resource": "introspect",
|
|
209
|
+
"scope": null,
|
|
210
|
+
"signature": "platform.introspect.apiKey(options?): PlatformAuth.IntrospectApiKey",
|
|
211
|
+
"snippet": "const introspectApiKey = await platform.introspect.apiKey();"
|
|
212
|
+
},
|
|
213
|
+
"IntrospectController_introspectWorkspace": {
|
|
214
|
+
"actor": null,
|
|
215
|
+
"deprecated": false,
|
|
216
|
+
"http": "GET /v1/introspect/workspaces/{workspace_id}",
|
|
217
|
+
"idempotent": false,
|
|
218
|
+
"method": "retrieve",
|
|
219
|
+
"paginated": false,
|
|
220
|
+
"params": null,
|
|
221
|
+
"poll": null,
|
|
222
|
+
"public": false,
|
|
223
|
+
"resource": "introspect.workspaces",
|
|
224
|
+
"scope": null,
|
|
225
|
+
"signature": "platform.introspect.workspaces.retrieve(workspaceId, options?): PlatformAuth.IntrospectWorkspace",
|
|
226
|
+
"snippet": "const introspectWorkspace = await platform.introspect.workspaces.retrieve(\"workspace\");"
|
|
227
|
+
},
|
|
228
|
+
"JwksController_jwks": {
|
|
229
|
+
"actor": null,
|
|
230
|
+
"deprecated": false,
|
|
231
|
+
"http": "GET /.well-known/jwks.json",
|
|
232
|
+
"idempotent": false,
|
|
233
|
+
"method": "jwks",
|
|
234
|
+
"paginated": false,
|
|
235
|
+
"params": null,
|
|
236
|
+
"poll": null,
|
|
237
|
+
"public": true,
|
|
238
|
+
"resource": "wellKnown",
|
|
239
|
+
"scope": null,
|
|
240
|
+
"signature": "platform.wellKnown.jwks(options?): PlatformAuth.Jwks",
|
|
241
|
+
"snippet": "const jwks = await platform.wellKnown.jwks();"
|
|
242
|
+
},
|
|
243
|
+
"MeController_getMe": {
|
|
244
|
+
"actor": null,
|
|
245
|
+
"deprecated": false,
|
|
246
|
+
"http": "GET /v1/me",
|
|
247
|
+
"idempotent": false,
|
|
248
|
+
"method": "retrieve",
|
|
249
|
+
"paginated": false,
|
|
250
|
+
"params": null,
|
|
251
|
+
"poll": null,
|
|
252
|
+
"public": false,
|
|
253
|
+
"resource": "me",
|
|
254
|
+
"scope": null,
|
|
255
|
+
"signature": "platform.me.retrieve(options?): PlatformAuth.MeProfile",
|
|
256
|
+
"snippet": "const meProfile = await platform.me.retrieve();"
|
|
257
|
+
},
|
|
258
|
+
"MeController_removeAvatar": {
|
|
259
|
+
"actor": null,
|
|
260
|
+
"deprecated": false,
|
|
261
|
+
"http": "DELETE /v1/me/avatar",
|
|
262
|
+
"idempotent": false,
|
|
263
|
+
"method": "clear",
|
|
264
|
+
"paginated": false,
|
|
265
|
+
"params": null,
|
|
266
|
+
"poll": null,
|
|
267
|
+
"public": false,
|
|
268
|
+
"resource": "me.avatar",
|
|
269
|
+
"scope": null,
|
|
270
|
+
"signature": "platform.me.avatar.clear(options?): void",
|
|
271
|
+
"snippet": "await platform.me.avatar.clear();"
|
|
272
|
+
},
|
|
273
|
+
"MeController_setAvatar": {
|
|
274
|
+
"actor": null,
|
|
275
|
+
"deprecated": false,
|
|
276
|
+
"http": "POST /v1/me/avatar",
|
|
277
|
+
"idempotent": false,
|
|
278
|
+
"method": "upload",
|
|
279
|
+
"paginated": false,
|
|
280
|
+
"params": "PlatformAuth.MeAvatarUploadParams",
|
|
281
|
+
"poll": null,
|
|
282
|
+
"public": false,
|
|
283
|
+
"resource": "me.avatar",
|
|
284
|
+
"scope": null,
|
|
285
|
+
"signature": "platform.me.avatar.upload(params, options?): PlatformAuth.AvatarUrl",
|
|
286
|
+
"snippet": "const avatarUrl = await platform.me.avatar.upload({ file: new File([\"…\"], \"image.png\", { type: \"image/png\" }) });"
|
|
287
|
+
},
|
|
288
|
+
"MeController_updateProfile": {
|
|
289
|
+
"actor": null,
|
|
290
|
+
"deprecated": false,
|
|
291
|
+
"http": "PATCH /v1/me/profile",
|
|
292
|
+
"idempotent": false,
|
|
293
|
+
"method": "update",
|
|
294
|
+
"paginated": false,
|
|
295
|
+
"params": "PlatformAuth.MeProfileUpdateParams",
|
|
296
|
+
"poll": null,
|
|
297
|
+
"public": false,
|
|
298
|
+
"resource": "me.profile",
|
|
299
|
+
"scope": null,
|
|
300
|
+
"signature": "platform.me.profile.update(params?, options?): PlatformAuth.MeProfile",
|
|
301
|
+
"snippet": "const meProfile = await platform.me.profile.update({ display_name: \"string\" });"
|
|
302
|
+
},
|
|
303
|
+
"OAuthAuthorizeController_connections": {
|
|
304
|
+
"actor": null,
|
|
305
|
+
"deprecated": false,
|
|
306
|
+
"http": "GET /v1/oauth/connections",
|
|
307
|
+
"idempotent": false,
|
|
308
|
+
"method": "list",
|
|
309
|
+
"paginated": true,
|
|
310
|
+
"params": "PlatformAuth.OauthConnectionListParams",
|
|
311
|
+
"poll": null,
|
|
312
|
+
"public": false,
|
|
313
|
+
"resource": "oauth.connections",
|
|
314
|
+
"scope": null,
|
|
315
|
+
"signature": "platform.oauth.connections.list(params?, options?): PagePromise<PlatformAuth.ConnectedClient>",
|
|
316
|
+
"snippet": "for await (const connection of platform.oauth.connections.list()) {\n console.log(connection);\n}\nconst page = await platform.oauth.connections.list({}, { timeout: 5_000 });"
|
|
317
|
+
},
|
|
318
|
+
"OAuthAuthorizeController_disconnect": {
|
|
319
|
+
"actor": null,
|
|
320
|
+
"deprecated": false,
|
|
321
|
+
"http": "DELETE /v1/oauth/connections/{grant_id}",
|
|
322
|
+
"idempotent": false,
|
|
323
|
+
"method": "delete",
|
|
324
|
+
"paginated": false,
|
|
325
|
+
"params": null,
|
|
326
|
+
"poll": null,
|
|
327
|
+
"public": false,
|
|
328
|
+
"resource": "oauth.connections",
|
|
329
|
+
"scope": null,
|
|
330
|
+
"signature": "platform.oauth.connections.delete(grantId, options?): void",
|
|
331
|
+
"snippet": "await platform.oauth.connections.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
332
|
+
},
|
|
333
|
+
"OAuthAuthorizeController_disconnectWorkspaceConnection": {
|
|
334
|
+
"actor": null,
|
|
335
|
+
"deprecated": false,
|
|
336
|
+
"http": "DELETE /v1/oauth/workspaces/{workspace_id}/connections/{grant_id}",
|
|
337
|
+
"idempotent": false,
|
|
338
|
+
"method": "delete",
|
|
339
|
+
"paginated": false,
|
|
340
|
+
"params": null,
|
|
341
|
+
"poll": null,
|
|
342
|
+
"public": false,
|
|
343
|
+
"resource": "oauth.workspaces.connections",
|
|
344
|
+
"scope": null,
|
|
345
|
+
"signature": "platform.oauth.workspaces.connections.delete(workspaceId, grantId, options?): void",
|
|
346
|
+
"snippet": "await platform.oauth.workspaces.connections.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
347
|
+
},
|
|
348
|
+
"OAuthAuthorizeController_restoreWorkspaceConnection": {
|
|
349
|
+
"actor": null,
|
|
350
|
+
"deprecated": false,
|
|
351
|
+
"http": "POST /v1/oauth/workspaces/{workspace_id}/connections/{grant_id}/restore",
|
|
352
|
+
"idempotent": false,
|
|
353
|
+
"method": "restore",
|
|
354
|
+
"paginated": false,
|
|
355
|
+
"params": null,
|
|
356
|
+
"poll": null,
|
|
357
|
+
"public": false,
|
|
358
|
+
"resource": "oauth.workspaces.connections",
|
|
359
|
+
"scope": null,
|
|
360
|
+
"signature": "platform.oauth.workspaces.connections.restore(workspaceId, grantId, options?): void",
|
|
361
|
+
"snippet": "await platform.oauth.workspaces.connections.restore(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
362
|
+
},
|
|
363
|
+
"OAuthAuthorizeController_workspaceConnections": {
|
|
364
|
+
"actor": null,
|
|
365
|
+
"deprecated": false,
|
|
366
|
+
"http": "GET /v1/oauth/workspaces/{workspace_id}/connections",
|
|
367
|
+
"idempotent": false,
|
|
368
|
+
"method": "list",
|
|
369
|
+
"paginated": true,
|
|
370
|
+
"params": "PlatformAuth.OauthWorkspaceConnectionListParams",
|
|
371
|
+
"poll": null,
|
|
372
|
+
"public": false,
|
|
373
|
+
"resource": "oauth.workspaces.connections",
|
|
374
|
+
"scope": null,
|
|
375
|
+
"signature": "platform.oauth.workspaces.connections.list(workspaceId, params?, options?): PagePromise<PlatformAuth.ConnectedClient>",
|
|
376
|
+
"snippet": "for await (const connection of platform.oauth.workspaces.connections.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\")) {\n console.log(connection);\n}\nconst page = await platform.oauth.workspaces.connections.list(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\", {}, { timeout: 5_000 });"
|
|
377
|
+
},
|
|
378
|
+
"PasswordController_requestPasswordReset": {
|
|
379
|
+
"actor": null,
|
|
380
|
+
"deprecated": false,
|
|
381
|
+
"http": "POST /v1/auth/password/request-reset",
|
|
382
|
+
"idempotent": false,
|
|
383
|
+
"method": "requestReset",
|
|
384
|
+
"paginated": false,
|
|
385
|
+
"params": "PlatformAuth.AuthPasswordRequestResetParams",
|
|
386
|
+
"poll": null,
|
|
387
|
+
"public": true,
|
|
388
|
+
"resource": "auth.password",
|
|
389
|
+
"scope": null,
|
|
390
|
+
"signature": "platform.auth.password.requestReset(params, options?): void",
|
|
391
|
+
"snippet": "await platform.auth.password.requestReset({ email: \"user@example.com\" });"
|
|
392
|
+
},
|
|
393
|
+
"PasswordController_resetPassword": {
|
|
394
|
+
"actor": null,
|
|
395
|
+
"deprecated": false,
|
|
396
|
+
"http": "POST /v1/auth/password/reset",
|
|
397
|
+
"idempotent": false,
|
|
398
|
+
"method": "reset",
|
|
399
|
+
"paginated": false,
|
|
400
|
+
"params": "PlatformAuth.AuthPasswordResetParams",
|
|
401
|
+
"poll": null,
|
|
402
|
+
"public": true,
|
|
403
|
+
"resource": "auth.password",
|
|
404
|
+
"scope": null,
|
|
405
|
+
"signature": "platform.auth.password.reset(params, options?): void",
|
|
406
|
+
"snippet": "await platform.auth.password.reset({ new_password: \"MyNewPassword123\", token: \"123456\" });"
|
|
407
|
+
},
|
|
408
|
+
"PlatformApiKeyController_create": {
|
|
409
|
+
"actor": null,
|
|
410
|
+
"deprecated": false,
|
|
411
|
+
"http": "POST /v1/workspaces/{workspace_slug}/api-keys",
|
|
412
|
+
"idempotent": true,
|
|
413
|
+
"method": "create",
|
|
414
|
+
"paginated": false,
|
|
415
|
+
"params": "PlatformAuth.WorkspaceApiKeyCreateParams",
|
|
416
|
+
"poll": null,
|
|
417
|
+
"public": false,
|
|
418
|
+
"resource": "workspaces.apiKeys",
|
|
419
|
+
"scope": null,
|
|
420
|
+
"signature": "platform.workspaces.apiKeys.create(workspaceSlug, params, options?): PlatformAuth.MintPak",
|
|
421
|
+
"snippet": "const mintPak = await platform.workspaces.apiKeys.create(\"workspace\", { name: \"Production social client\" });"
|
|
422
|
+
},
|
|
423
|
+
"PlatformApiKeyController_get": {
|
|
424
|
+
"actor": null,
|
|
425
|
+
"deprecated": false,
|
|
426
|
+
"http": "GET /v1/workspaces/{workspace_slug}/api-keys/{id}",
|
|
427
|
+
"idempotent": false,
|
|
428
|
+
"method": "retrieve",
|
|
429
|
+
"paginated": false,
|
|
430
|
+
"params": null,
|
|
431
|
+
"poll": null,
|
|
432
|
+
"public": false,
|
|
433
|
+
"resource": "workspaces.apiKeys",
|
|
434
|
+
"scope": null,
|
|
435
|
+
"signature": "platform.workspaces.apiKeys.retrieve(workspaceSlug, id, options?): PlatformAuth.PublicApiKey",
|
|
436
|
+
"snippet": "const publicApiKey = await platform.workspaces.apiKeys.retrieve(\"workspace\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
437
|
+
},
|
|
438
|
+
"PlatformApiKeyController_list": {
|
|
439
|
+
"actor": null,
|
|
440
|
+
"deprecated": false,
|
|
441
|
+
"http": "GET /v1/workspaces/{workspace_slug}/api-keys",
|
|
442
|
+
"idempotent": false,
|
|
443
|
+
"method": "list",
|
|
444
|
+
"paginated": true,
|
|
445
|
+
"params": "PlatformAuth.WorkspaceApiKeyListParams",
|
|
446
|
+
"poll": null,
|
|
447
|
+
"public": false,
|
|
448
|
+
"resource": "workspaces.apiKeys",
|
|
449
|
+
"scope": null,
|
|
450
|
+
"signature": "platform.workspaces.apiKeys.list(workspaceSlug, params?, options?): PagePromise<PlatformAuth.PublicApiKey>",
|
|
451
|
+
"snippet": "for await (const apiKey of platform.workspaces.apiKeys.list(\"workspace\")) {\n console.log(apiKey);\n}\nconst page = await platform.workspaces.apiKeys.list(\"workspace\", {}, { timeout: 5_000 });"
|
|
452
|
+
},
|
|
453
|
+
"PlatformApiKeyController_presets": {
|
|
454
|
+
"actor": null,
|
|
455
|
+
"deprecated": false,
|
|
456
|
+
"http": "GET /v1/workspaces/{workspace_slug}/api-keys/presets",
|
|
457
|
+
"idempotent": false,
|
|
458
|
+
"method": "list",
|
|
459
|
+
"paginated": true,
|
|
460
|
+
"params": null,
|
|
461
|
+
"poll": null,
|
|
462
|
+
"public": false,
|
|
463
|
+
"resource": "workspaces.apiKeys.presets",
|
|
464
|
+
"scope": null,
|
|
465
|
+
"signature": "platform.workspaces.apiKeys.presets.list(workspaceSlug, options?): PagePromise<PlatformAuth.PakPreset>",
|
|
466
|
+
"snippet": "for await (const preset of platform.workspaces.apiKeys.presets.list(\"workspace\")) {\n console.log(preset);\n}"
|
|
467
|
+
},
|
|
468
|
+
"PlatformApiKeyController_preview": {
|
|
469
|
+
"actor": null,
|
|
470
|
+
"deprecated": false,
|
|
471
|
+
"http": "POST /v1/workspaces/{workspace_slug}/api-keys/preview",
|
|
472
|
+
"idempotent": false,
|
|
473
|
+
"method": "preview",
|
|
474
|
+
"paginated": false,
|
|
475
|
+
"params": "PlatformAuth.WorkspaceApiKeyPreviewParams",
|
|
476
|
+
"poll": null,
|
|
477
|
+
"public": false,
|
|
478
|
+
"resource": "workspaces.apiKeys",
|
|
479
|
+
"scope": null,
|
|
480
|
+
"signature": "platform.workspaces.apiKeys.preview(workspaceSlug, params?, options?): PlatformAuth.PakGrantPreview",
|
|
481
|
+
"snippet": "const pakGrantPreview = await platform.workspaces.apiKeys.preview(\"workspace\", { policy_ids: [\"11111111-1111-1111-1111-111111111111\"] });"
|
|
482
|
+
},
|
|
483
|
+
"PlatformApiKeyController_revoke": {
|
|
484
|
+
"actor": null,
|
|
485
|
+
"deprecated": false,
|
|
486
|
+
"http": "DELETE /v1/workspaces/{workspace_slug}/api-keys/{id}",
|
|
487
|
+
"idempotent": false,
|
|
488
|
+
"method": "delete",
|
|
489
|
+
"paginated": false,
|
|
490
|
+
"params": "PlatformAuth.WorkspaceApiKeyDeleteParams",
|
|
491
|
+
"poll": null,
|
|
492
|
+
"public": false,
|
|
493
|
+
"resource": "workspaces.apiKeys",
|
|
494
|
+
"scope": null,
|
|
495
|
+
"signature": "platform.workspaces.apiKeys.delete(workspaceSlug, id, params?, options?): void",
|
|
496
|
+
"snippet": "await platform.workspaces.apiKeys.delete(\"workspace\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
497
|
+
},
|
|
498
|
+
"PlatformApiKeyController_rotate": {
|
|
499
|
+
"actor": null,
|
|
500
|
+
"deprecated": false,
|
|
501
|
+
"http": "POST /v1/workspaces/{workspace_slug}/api-keys/{id}/rotate",
|
|
502
|
+
"idempotent": false,
|
|
503
|
+
"method": "rotate",
|
|
504
|
+
"paginated": false,
|
|
505
|
+
"params": "PlatformAuth.WorkspaceApiKeyRotateParams",
|
|
506
|
+
"poll": null,
|
|
507
|
+
"public": false,
|
|
508
|
+
"resource": "workspaces.apiKeys",
|
|
509
|
+
"scope": null,
|
|
510
|
+
"signature": "platform.workspaces.apiKeys.rotate(workspaceSlug, id, params?, options?): PlatformAuth.RotatePak",
|
|
511
|
+
"snippet": "const rotatePak = await platform.workspaces.apiKeys.rotate(\"workspace\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { grace_hours: 24 });"
|
|
512
|
+
},
|
|
513
|
+
"PlatformApiKeyController_setBindings": {
|
|
514
|
+
"actor": null,
|
|
515
|
+
"deprecated": false,
|
|
516
|
+
"http": "PATCH /v1/workspaces/{workspace_slug}/api-keys/{id}/bindings",
|
|
517
|
+
"idempotent": false,
|
|
518
|
+
"method": "updateBindings",
|
|
519
|
+
"paginated": false,
|
|
520
|
+
"params": "PlatformAuth.WorkspaceApiKeyUpdateBindingsParams",
|
|
521
|
+
"poll": null,
|
|
522
|
+
"public": false,
|
|
523
|
+
"resource": "workspaces.apiKeys",
|
|
524
|
+
"scope": null,
|
|
525
|
+
"signature": "platform.workspaces.apiKeys.updateBindings(workspaceSlug, id, params, options?): PlatformAuth.PublicApiKey",
|
|
526
|
+
"snippet": "const publicApiKey = await platform.workspaces.apiKeys.updateBindings(\"workspace\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { policy_ids: [\"string\"] });"
|
|
527
|
+
},
|
|
528
|
+
"PlatformApiKeyController_update": {
|
|
529
|
+
"actor": null,
|
|
530
|
+
"deprecated": false,
|
|
531
|
+
"http": "PATCH /v1/workspaces/{workspace_slug}/api-keys/{id}",
|
|
532
|
+
"idempotent": false,
|
|
533
|
+
"method": "update",
|
|
534
|
+
"paginated": false,
|
|
535
|
+
"params": "PlatformAuth.WorkspaceApiKeyUpdateParams",
|
|
536
|
+
"poll": null,
|
|
537
|
+
"public": false,
|
|
538
|
+
"resource": "workspaces.apiKeys",
|
|
539
|
+
"scope": null,
|
|
540
|
+
"signature": "platform.workspaces.apiKeys.update(workspaceSlug, id, params?, options?): PlatformAuth.PublicApiKey",
|
|
541
|
+
"snippet": "const publicApiKey = await platform.workspaces.apiKeys.update(\"workspace\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { description: \"string\" });"
|
|
542
|
+
},
|
|
543
|
+
"SessionController_getSessions": {
|
|
544
|
+
"actor": null,
|
|
545
|
+
"deprecated": false,
|
|
546
|
+
"http": "GET /v1/session",
|
|
547
|
+
"idempotent": false,
|
|
548
|
+
"method": "list",
|
|
549
|
+
"paginated": false,
|
|
550
|
+
"params": null,
|
|
551
|
+
"poll": null,
|
|
552
|
+
"public": false,
|
|
553
|
+
"resource": "sessions",
|
|
554
|
+
"scope": null,
|
|
555
|
+
"signature": "platform.sessions.list(options?): PlatformAuth.SessionListResponse",
|
|
556
|
+
"snippet": "const result = await platform.sessions.list();"
|
|
557
|
+
},
|
|
558
|
+
"SessionController_revokeOtherSessions": {
|
|
559
|
+
"actor": null,
|
|
560
|
+
"deprecated": false,
|
|
561
|
+
"http": "POST /v1/session/revoke-others",
|
|
562
|
+
"idempotent": false,
|
|
563
|
+
"method": "revokeOthers",
|
|
564
|
+
"paginated": false,
|
|
565
|
+
"params": null,
|
|
566
|
+
"poll": null,
|
|
567
|
+
"public": false,
|
|
568
|
+
"resource": "sessions",
|
|
569
|
+
"scope": null,
|
|
570
|
+
"signature": "platform.sessions.revokeOthers(options?): PlatformAuth.RevokeOtherSessions",
|
|
571
|
+
"snippet": "const revokeOtherSessions = await platform.sessions.revokeOthers();"
|
|
572
|
+
},
|
|
573
|
+
"SessionController_revokeSession": {
|
|
574
|
+
"actor": null,
|
|
575
|
+
"deprecated": false,
|
|
576
|
+
"http": "DELETE /v1/session/{id}",
|
|
577
|
+
"idempotent": false,
|
|
578
|
+
"method": "delete",
|
|
579
|
+
"paginated": false,
|
|
580
|
+
"params": null,
|
|
581
|
+
"poll": null,
|
|
582
|
+
"public": false,
|
|
583
|
+
"resource": "sessions",
|
|
584
|
+
"scope": null,
|
|
585
|
+
"signature": "platform.sessions.delete(id, options?): PlatformAuth.RevokeSession",
|
|
586
|
+
"snippet": "const revokeSession = await platform.sessions.delete(\"3f0c1a2b-4c5d-4e6f-8a9b-0c1d2e3f4a5b\");"
|
|
587
|
+
},
|
|
588
|
+
"VerificationController_resend": {
|
|
589
|
+
"actor": null,
|
|
590
|
+
"deprecated": false,
|
|
591
|
+
"http": "POST /v1/verification/resend",
|
|
592
|
+
"idempotent": false,
|
|
593
|
+
"method": "resend",
|
|
594
|
+
"paginated": false,
|
|
595
|
+
"params": null,
|
|
596
|
+
"poll": null,
|
|
597
|
+
"public": false,
|
|
598
|
+
"resource": "verification",
|
|
599
|
+
"scope": null,
|
|
600
|
+
"signature": "platform.verification.resend(options?): PlatformAuth.Feedback",
|
|
601
|
+
"snippet": "const feedback = await platform.verification.resend();"
|
|
602
|
+
},
|
|
603
|
+
"VerificationController_verify": {
|
|
604
|
+
"actor": null,
|
|
605
|
+
"deprecated": false,
|
|
606
|
+
"http": "POST /v1/verification/verify",
|
|
607
|
+
"idempotent": false,
|
|
608
|
+
"method": "verify",
|
|
609
|
+
"paginated": false,
|
|
610
|
+
"params": "PlatformAuth.VerificationVerifyParams",
|
|
611
|
+
"poll": null,
|
|
612
|
+
"public": true,
|
|
613
|
+
"resource": "verification",
|
|
614
|
+
"scope": null,
|
|
615
|
+
"signature": "platform.verification.verify(params, options?): PlatformAuth.Feedback",
|
|
616
|
+
"snippet": "const feedback = await platform.verification.verify({ code: \"a1b2c3d4…\" });"
|
|
617
|
+
},
|
|
618
|
+
"WorkspaceAuditController_exportAuditLogs": {
|
|
619
|
+
"actor": "query",
|
|
620
|
+
"deprecated": false,
|
|
621
|
+
"http": "GET /v1/workspaces/{workspace_slug}/audit-logs/export",
|
|
622
|
+
"idempotent": false,
|
|
623
|
+
"method": "export",
|
|
624
|
+
"paginated": false,
|
|
625
|
+
"params": "PlatformAuth.WorkspaceAuditLogExportParams",
|
|
626
|
+
"poll": null,
|
|
627
|
+
"public": false,
|
|
628
|
+
"resource": "workspaces.auditLogs",
|
|
629
|
+
"scope": null,
|
|
630
|
+
"signature": "platform.workspaces.auditLogs.export(workspaceSlug, params?, options?): Response",
|
|
631
|
+
"snippet": "const response = await platform.workspaces.auditLogs.export(\"workspace\");\nconst text = await response.text();"
|
|
632
|
+
},
|
|
633
|
+
"WorkspaceAuditController_listAuditLogs": {
|
|
634
|
+
"actor": "query",
|
|
635
|
+
"deprecated": false,
|
|
636
|
+
"http": "GET /v1/workspaces/{workspace_slug}/audit-logs",
|
|
637
|
+
"idempotent": false,
|
|
638
|
+
"method": "list",
|
|
639
|
+
"paginated": true,
|
|
640
|
+
"params": "PlatformAuth.WorkspaceAuditLogListParams",
|
|
641
|
+
"poll": null,
|
|
642
|
+
"public": false,
|
|
643
|
+
"resource": "workspaces.auditLogs",
|
|
644
|
+
"scope": null,
|
|
645
|
+
"signature": "platform.workspaces.auditLogs.list(workspaceSlug, params?, options?): PagePromise<PlatformAuth.WorkspaceAuditLogEntry>",
|
|
646
|
+
"snippet": "for await (const auditLog of platform.workspaces.auditLogs.list(\"workspace\")) {\n console.log(auditLog);\n}\nconst page = await platform.workspaces.auditLogs.list(\"workspace\", {}, { timeout: 5_000 });"
|
|
647
|
+
},
|
|
648
|
+
"WorkspaceAuditFeedController_listFeed": {
|
|
649
|
+
"actor": "query",
|
|
650
|
+
"deprecated": false,
|
|
651
|
+
"http": "GET /v1/workspaces/{workspace_slug}/audit-feed",
|
|
652
|
+
"idempotent": false,
|
|
653
|
+
"method": "list",
|
|
654
|
+
"paginated": true,
|
|
655
|
+
"params": "PlatformAuth.WorkspaceAuditFeedListParams",
|
|
656
|
+
"poll": null,
|
|
657
|
+
"public": false,
|
|
658
|
+
"resource": "workspaces.auditFeed",
|
|
659
|
+
"scope": null,
|
|
660
|
+
"signature": "platform.workspaces.auditFeed.list(workspaceSlug, params?, options?): PagePromise<PlatformAuth.FeedItem>",
|
|
661
|
+
"snippet": "for await (const auditFeed of platform.workspaces.auditFeed.list(\"workspace\")) {\n console.log(auditFeed);\n}\nconst page = await platform.workspaces.auditFeed.list(\"workspace\", {}, { timeout: 5_000 });"
|
|
662
|
+
},
|
|
663
|
+
"WorkspaceController_acceptInvite": {
|
|
664
|
+
"actor": null,
|
|
665
|
+
"deprecated": false,
|
|
666
|
+
"http": "POST /v1/workspaces/invites/accept",
|
|
667
|
+
"idempotent": false,
|
|
668
|
+
"method": "accept",
|
|
669
|
+
"paginated": false,
|
|
670
|
+
"params": "PlatformAuth.WorkspaceInviteAcceptParams",
|
|
671
|
+
"poll": null,
|
|
672
|
+
"public": false,
|
|
673
|
+
"resource": "workspaces.invites",
|
|
674
|
+
"scope": null,
|
|
675
|
+
"signature": "platform.workspaces.invites.accept(params, options?): PlatformAuth.Workspace",
|
|
676
|
+
"snippet": "const workspace = await platform.workspaces.invites.accept({ code: \"inv_…\" });"
|
|
677
|
+
},
|
|
678
|
+
"WorkspaceController_createInvite": {
|
|
679
|
+
"actor": null,
|
|
680
|
+
"deprecated": false,
|
|
681
|
+
"http": "POST /v1/workspaces/{workspace_slug}/invites",
|
|
682
|
+
"idempotent": true,
|
|
683
|
+
"method": "create",
|
|
684
|
+
"paginated": false,
|
|
685
|
+
"params": "PlatformAuth.WorkspaceInviteCreateParams",
|
|
686
|
+
"poll": null,
|
|
687
|
+
"public": false,
|
|
688
|
+
"resource": "workspaces.invites",
|
|
689
|
+
"scope": null,
|
|
690
|
+
"signature": "platform.workspaces.invites.create(workspaceSlug, params?, options?): PlatformAuth.WorkspaceInvite",
|
|
691
|
+
"snippet": "const workspaceInvite = await platform.workspaces.invites.create(\"workspace\", { email: \"alice@example.com\" });"
|
|
692
|
+
},
|
|
693
|
+
"WorkspaceController_createWorkspace": {
|
|
694
|
+
"actor": null,
|
|
695
|
+
"deprecated": false,
|
|
696
|
+
"http": "POST /v1/workspaces",
|
|
697
|
+
"idempotent": true,
|
|
698
|
+
"method": "create",
|
|
699
|
+
"paginated": false,
|
|
700
|
+
"params": "PlatformAuth.WorkspaceCreateParams",
|
|
701
|
+
"poll": null,
|
|
702
|
+
"public": false,
|
|
703
|
+
"resource": "workspaces",
|
|
704
|
+
"scope": null,
|
|
705
|
+
"signature": "platform.workspaces.create(params, options?): PlatformAuth.Workspace",
|
|
706
|
+
"snippet": "const workspace = await platform.workspaces.create({ display_name: \"Acme Corp\", slug: \"acme-corp\" });"
|
|
707
|
+
},
|
|
708
|
+
"WorkspaceController_deleteWorkspace": {
|
|
709
|
+
"actor": null,
|
|
710
|
+
"deprecated": false,
|
|
711
|
+
"http": "DELETE /v1/workspaces/{workspace_slug}",
|
|
712
|
+
"idempotent": false,
|
|
713
|
+
"method": "delete",
|
|
714
|
+
"paginated": false,
|
|
715
|
+
"params": null,
|
|
716
|
+
"poll": null,
|
|
717
|
+
"public": false,
|
|
718
|
+
"resource": "workspaces",
|
|
719
|
+
"scope": null,
|
|
720
|
+
"signature": "platform.workspaces.delete(workspaceSlug, options?): void",
|
|
721
|
+
"snippet": "await platform.workspaces.delete(\"workspace\");"
|
|
722
|
+
},
|
|
723
|
+
"WorkspaceController_getWorkspace": {
|
|
724
|
+
"actor": null,
|
|
725
|
+
"deprecated": false,
|
|
726
|
+
"http": "GET /v1/workspaces/{workspace_slug}",
|
|
727
|
+
"idempotent": false,
|
|
728
|
+
"method": "retrieve",
|
|
729
|
+
"paginated": false,
|
|
730
|
+
"params": null,
|
|
731
|
+
"poll": null,
|
|
732
|
+
"public": false,
|
|
733
|
+
"resource": "workspaces",
|
|
734
|
+
"scope": null,
|
|
735
|
+
"signature": "platform.workspaces.retrieve(workspaceSlug, options?): PlatformAuth.Workspace",
|
|
736
|
+
"snippet": "const workspace = await platform.workspaces.retrieve(\"workspace\");"
|
|
737
|
+
},
|
|
738
|
+
"WorkspaceController_listInvites": {
|
|
739
|
+
"actor": null,
|
|
740
|
+
"deprecated": false,
|
|
741
|
+
"http": "GET /v1/workspaces/{workspace_slug}/invites",
|
|
742
|
+
"idempotent": false,
|
|
743
|
+
"method": "list",
|
|
744
|
+
"paginated": true,
|
|
745
|
+
"params": "PlatformAuth.WorkspaceInviteListParams",
|
|
746
|
+
"poll": null,
|
|
747
|
+
"public": false,
|
|
748
|
+
"resource": "workspaces.invites",
|
|
749
|
+
"scope": null,
|
|
750
|
+
"signature": "platform.workspaces.invites.list(workspaceSlug, params?, options?): PagePromise<PlatformAuth.WorkspaceInviteListItem>",
|
|
751
|
+
"snippet": "for await (const invite of platform.workspaces.invites.list(\"workspace\")) {\n console.log(invite);\n}\nconst page = await platform.workspaces.invites.list(\"workspace\", {}, { timeout: 5_000 });"
|
|
752
|
+
},
|
|
753
|
+
"WorkspaceController_listMembers": {
|
|
754
|
+
"actor": null,
|
|
755
|
+
"deprecated": false,
|
|
756
|
+
"http": "GET /v1/workspaces/{workspace_slug}/members",
|
|
757
|
+
"idempotent": false,
|
|
758
|
+
"method": "list",
|
|
759
|
+
"paginated": true,
|
|
760
|
+
"params": "PlatformAuth.WorkspaceMemberListParams",
|
|
761
|
+
"poll": null,
|
|
762
|
+
"public": false,
|
|
763
|
+
"resource": "workspaces.members",
|
|
764
|
+
"scope": null,
|
|
765
|
+
"signature": "platform.workspaces.members.list(workspaceSlug, params?, options?): PagePromise<PlatformAuth.WorkspaceMember>",
|
|
766
|
+
"snippet": "for await (const member of platform.workspaces.members.list(\"workspace\")) {\n console.log(member);\n}\nconst page = await platform.workspaces.members.list(\"workspace\", {}, { timeout: 5_000 });"
|
|
767
|
+
},
|
|
768
|
+
"WorkspaceController_listWorkspaces": {
|
|
769
|
+
"actor": null,
|
|
770
|
+
"deprecated": false,
|
|
771
|
+
"http": "GET /v1/workspaces",
|
|
772
|
+
"idempotent": false,
|
|
773
|
+
"method": "list",
|
|
774
|
+
"paginated": true,
|
|
775
|
+
"params": "PlatformAuth.WorkspaceListParams",
|
|
776
|
+
"poll": null,
|
|
777
|
+
"public": false,
|
|
778
|
+
"resource": "workspaces",
|
|
779
|
+
"scope": null,
|
|
780
|
+
"signature": "platform.workspaces.list(params?, options?): PagePromise<PlatformAuth.WorkspaceListItem>",
|
|
781
|
+
"snippet": "for await (const workspace of platform.workspaces.list()) {\n console.log(workspace);\n}\nconst page = await platform.workspaces.list({}, { timeout: 5_000 });"
|
|
782
|
+
},
|
|
783
|
+
"WorkspaceController_removeAvatar": {
|
|
784
|
+
"actor": null,
|
|
785
|
+
"deprecated": false,
|
|
786
|
+
"http": "DELETE /v1/workspaces/{workspace_slug}/avatar",
|
|
787
|
+
"idempotent": false,
|
|
788
|
+
"method": "clear",
|
|
789
|
+
"paginated": false,
|
|
790
|
+
"params": null,
|
|
791
|
+
"poll": null,
|
|
792
|
+
"public": false,
|
|
793
|
+
"resource": "workspaces.avatar",
|
|
794
|
+
"scope": null,
|
|
795
|
+
"signature": "platform.workspaces.avatar.clear(workspaceSlug, options?): void",
|
|
796
|
+
"snippet": "await platform.workspaces.avatar.clear(\"workspace\");"
|
|
797
|
+
},
|
|
798
|
+
"WorkspaceController_removeMember": {
|
|
799
|
+
"actor": null,
|
|
800
|
+
"deprecated": false,
|
|
801
|
+
"http": "DELETE /v1/workspaces/{workspace_slug}/members/{account_id}",
|
|
802
|
+
"idempotent": false,
|
|
803
|
+
"method": "delete",
|
|
804
|
+
"paginated": false,
|
|
805
|
+
"params": null,
|
|
806
|
+
"poll": null,
|
|
807
|
+
"public": false,
|
|
808
|
+
"resource": "workspaces.members",
|
|
809
|
+
"scope": null,
|
|
810
|
+
"signature": "platform.workspaces.members.delete(workspaceSlug, accountId, options?): void",
|
|
811
|
+
"snippet": "await platform.workspaces.members.delete(\"workspace\", \"account\");"
|
|
812
|
+
},
|
|
813
|
+
"WorkspaceController_revokeInvite": {
|
|
814
|
+
"actor": null,
|
|
815
|
+
"deprecated": false,
|
|
816
|
+
"http": "DELETE /v1/workspaces/{workspace_slug}/invites/{invite_id}",
|
|
817
|
+
"idempotent": false,
|
|
818
|
+
"method": "delete",
|
|
819
|
+
"paginated": false,
|
|
820
|
+
"params": null,
|
|
821
|
+
"poll": null,
|
|
822
|
+
"public": false,
|
|
823
|
+
"resource": "workspaces.invites",
|
|
824
|
+
"scope": null,
|
|
825
|
+
"signature": "platform.workspaces.invites.delete(workspaceSlug, inviteId, options?): void",
|
|
826
|
+
"snippet": "await platform.workspaces.invites.delete(\"workspace\", \"invite\");"
|
|
827
|
+
},
|
|
828
|
+
"WorkspaceController_setAvatar": {
|
|
829
|
+
"actor": null,
|
|
830
|
+
"deprecated": false,
|
|
831
|
+
"http": "POST /v1/workspaces/{workspace_slug}/avatar",
|
|
832
|
+
"idempotent": false,
|
|
833
|
+
"method": "upload",
|
|
834
|
+
"paginated": false,
|
|
835
|
+
"params": "PlatformAuth.WorkspaceAvatarUploadParams",
|
|
836
|
+
"poll": null,
|
|
837
|
+
"public": false,
|
|
838
|
+
"resource": "workspaces.avatar",
|
|
839
|
+
"scope": null,
|
|
840
|
+
"signature": "platform.workspaces.avatar.upload(workspaceSlug, params, options?): PlatformAuth.WorkspaceAvatarUrl",
|
|
841
|
+
"snippet": "const workspaceAvatarUrl = await platform.workspaces.avatar.upload(\"workspace\", { file: new File([\"…\"], \"image.png\", { type: \"image/png\" }) });"
|
|
842
|
+
},
|
|
843
|
+
"WorkspaceController_updateMemberRole": {
|
|
844
|
+
"actor": null,
|
|
845
|
+
"deprecated": false,
|
|
846
|
+
"http": "PATCH /v1/workspaces/{workspace_slug}/members/{account_id}/role",
|
|
847
|
+
"idempotent": false,
|
|
848
|
+
"method": "updateRole",
|
|
849
|
+
"paginated": false,
|
|
850
|
+
"params": "PlatformAuth.WorkspaceMemberUpdateRoleParams",
|
|
851
|
+
"poll": null,
|
|
852
|
+
"public": false,
|
|
853
|
+
"resource": "workspaces.members",
|
|
854
|
+
"scope": null,
|
|
855
|
+
"signature": "platform.workspaces.members.updateRole(workspaceSlug, accountId, params?, options?): PlatformAuth.UpdateMemberRole",
|
|
856
|
+
"snippet": "const updateMemberRole = await platform.workspaces.members.updateRole(\"workspace\", \"account\", { role: \"owner\" });"
|
|
857
|
+
},
|
|
858
|
+
"WorkspaceController_updateWorkspace": {
|
|
859
|
+
"actor": null,
|
|
860
|
+
"deprecated": false,
|
|
861
|
+
"http": "PATCH /v1/workspaces/{workspace_slug}",
|
|
862
|
+
"idempotent": false,
|
|
863
|
+
"method": "update",
|
|
864
|
+
"paginated": false,
|
|
865
|
+
"params": "PlatformAuth.WorkspaceUpdateParams",
|
|
866
|
+
"poll": null,
|
|
867
|
+
"public": false,
|
|
868
|
+
"resource": "workspaces",
|
|
869
|
+
"scope": null,
|
|
870
|
+
"signature": "platform.workspaces.update(workspaceSlug, params?, options?): PlatformAuth.Workspace",
|
|
871
|
+
"snippet": "const workspace = await platform.workspaces.update(\"workspace\", { display_name: \"string\" });"
|
|
872
|
+
},
|
|
873
|
+
"WorkspacePolicyController_catalog": {
|
|
874
|
+
"actor": null,
|
|
875
|
+
"deprecated": false,
|
|
876
|
+
"http": "GET /v1/workspaces/{workspace_slug}/policies/actions/catalog",
|
|
877
|
+
"idempotent": false,
|
|
878
|
+
"method": "catalog",
|
|
879
|
+
"paginated": false,
|
|
880
|
+
"params": null,
|
|
881
|
+
"poll": null,
|
|
882
|
+
"public": false,
|
|
883
|
+
"resource": "workspaces.policies.actions",
|
|
884
|
+
"scope": null,
|
|
885
|
+
"signature": "platform.workspaces.policies.actions.catalog(workspaceSlug, options?): PlatformAuth.WorkspaceActionCatalog",
|
|
886
|
+
"snippet": "const workspaceActionCatalog = await platform.workspaces.policies.actions.catalog(\"workspace\");"
|
|
887
|
+
},
|
|
888
|
+
"WorkspacePolicyController_create": {
|
|
889
|
+
"actor": null,
|
|
890
|
+
"deprecated": false,
|
|
891
|
+
"http": "POST /v1/workspaces/{workspace_slug}/policies",
|
|
892
|
+
"idempotent": true,
|
|
893
|
+
"method": "create",
|
|
894
|
+
"paginated": false,
|
|
895
|
+
"params": "PlatformAuth.WorkspacePolicyCreateParams",
|
|
896
|
+
"poll": null,
|
|
897
|
+
"public": false,
|
|
898
|
+
"resource": "workspaces.policies",
|
|
899
|
+
"scope": null,
|
|
900
|
+
"signature": "platform.workspaces.policies.create(workspaceSlug, params, options?): PlatformAuth.ManagedPolicy",
|
|
901
|
+
"snippet": "const managedPolicy = await platform.workspaces.policies.create(\"workspace\", {\n name: \"mail-readonly\",\n policy: [{ actions: [\"mail.read\", \"mail.list\"], effect: \"allow\", resources: [\"*\"] }],\n});"
|
|
902
|
+
},
|
|
903
|
+
"WorkspacePolicyController_delete": {
|
|
904
|
+
"actor": null,
|
|
905
|
+
"deprecated": false,
|
|
906
|
+
"http": "DELETE /v1/workspaces/{workspace_slug}/policies/{policy_id}",
|
|
907
|
+
"idempotent": false,
|
|
908
|
+
"method": "delete",
|
|
909
|
+
"paginated": false,
|
|
910
|
+
"params": null,
|
|
911
|
+
"poll": null,
|
|
912
|
+
"public": false,
|
|
913
|
+
"resource": "workspaces.policies",
|
|
914
|
+
"scope": null,
|
|
915
|
+
"signature": "platform.workspaces.policies.delete(workspaceSlug, policyId, options?): PlatformAuth.ManagedPolicyDeleted",
|
|
916
|
+
"snippet": "const managedPolicyDeleted = await platform.workspaces.policies.delete(\"workspace\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
917
|
+
},
|
|
918
|
+
"WorkspacePolicyController_get": {
|
|
919
|
+
"actor": null,
|
|
920
|
+
"deprecated": false,
|
|
921
|
+
"http": "GET /v1/workspaces/{workspace_slug}/policies/{policy_id}",
|
|
922
|
+
"idempotent": false,
|
|
923
|
+
"method": "retrieve",
|
|
924
|
+
"paginated": false,
|
|
925
|
+
"params": null,
|
|
926
|
+
"poll": null,
|
|
927
|
+
"public": false,
|
|
928
|
+
"resource": "workspaces.policies",
|
|
929
|
+
"scope": null,
|
|
930
|
+
"signature": "platform.workspaces.policies.retrieve(workspaceSlug, policyId, options?): PlatformAuth.ManagedPolicyDetail",
|
|
931
|
+
"snippet": "const managedPolicyDetail = await platform.workspaces.policies.retrieve(\"workspace\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
932
|
+
},
|
|
933
|
+
"WorkspacePolicyController_list": {
|
|
934
|
+
"actor": null,
|
|
935
|
+
"deprecated": false,
|
|
936
|
+
"http": "GET /v1/workspaces/{workspace_slug}/policies",
|
|
937
|
+
"idempotent": false,
|
|
938
|
+
"method": "list",
|
|
939
|
+
"paginated": true,
|
|
940
|
+
"params": "PlatformAuth.WorkspacePolicyListParams",
|
|
941
|
+
"poll": null,
|
|
942
|
+
"public": false,
|
|
943
|
+
"resource": "workspaces.policies",
|
|
944
|
+
"scope": null,
|
|
945
|
+
"signature": "platform.workspaces.policies.list(workspaceSlug, params?, options?): PagePromise<PlatformAuth.ManagedPolicy>",
|
|
946
|
+
"snippet": "for await (const policy of platform.workspaces.policies.list(\"workspace\")) {\n console.log(policy);\n}\nconst page = await platform.workspaces.policies.list(\"workspace\", {}, { timeout: 5_000 });"
|
|
947
|
+
},
|
|
948
|
+
"WorkspacePolicyController_update": {
|
|
949
|
+
"actor": null,
|
|
950
|
+
"deprecated": false,
|
|
951
|
+
"http": "PATCH /v1/workspaces/{workspace_slug}/policies/{policy_id}",
|
|
952
|
+
"idempotent": false,
|
|
953
|
+
"method": "update",
|
|
954
|
+
"paginated": false,
|
|
955
|
+
"params": "PlatformAuth.WorkspacePolicyUpdateParams",
|
|
956
|
+
"poll": null,
|
|
957
|
+
"public": false,
|
|
958
|
+
"resource": "workspaces.policies",
|
|
959
|
+
"scope": null,
|
|
960
|
+
"signature": "platform.workspaces.policies.update(workspaceSlug, policyId, params?, options?): PlatformAuth.ManagedPolicyDetail",
|
|
961
|
+
"snippet": "const managedPolicyDetail = await platform.workspaces.policies.update(\"workspace\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { description: \"Read-only access to all Mail resources\" });"
|
|
962
|
+
},
|
|
963
|
+
"WorkspaceRoleController_create": {
|
|
964
|
+
"actor": null,
|
|
965
|
+
"deprecated": false,
|
|
966
|
+
"http": "POST /v1/workspaces/{workspace_slug}/roles",
|
|
967
|
+
"idempotent": true,
|
|
968
|
+
"method": "create",
|
|
969
|
+
"paginated": false,
|
|
970
|
+
"params": "PlatformAuth.WorkspaceRoleCreateParams",
|
|
971
|
+
"poll": null,
|
|
972
|
+
"public": false,
|
|
973
|
+
"resource": "workspaces.roles",
|
|
974
|
+
"scope": null,
|
|
975
|
+
"signature": "platform.workspaces.roles.create(workspaceSlug, params, options?): PlatformAuth.WorkspaceRole",
|
|
976
|
+
"snippet": "const workspaceRole = await platform.workspaces.roles.create(\"workspace\", { name: \"BillingAdmin\" });"
|
|
977
|
+
},
|
|
978
|
+
"WorkspaceRoleController_delete": {
|
|
979
|
+
"actor": null,
|
|
980
|
+
"deprecated": false,
|
|
981
|
+
"http": "DELETE /v1/workspaces/{workspace_slug}/roles/{role_id}",
|
|
982
|
+
"idempotent": false,
|
|
983
|
+
"method": "delete",
|
|
984
|
+
"paginated": false,
|
|
985
|
+
"params": null,
|
|
986
|
+
"poll": null,
|
|
987
|
+
"public": false,
|
|
988
|
+
"resource": "workspaces.roles",
|
|
989
|
+
"scope": null,
|
|
990
|
+
"signature": "platform.workspaces.roles.delete(workspaceSlug, roleId, options?): void",
|
|
991
|
+
"snippet": "await platform.workspaces.roles.delete(\"workspace\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
992
|
+
},
|
|
993
|
+
"WorkspaceRoleController_get": {
|
|
994
|
+
"actor": null,
|
|
995
|
+
"deprecated": false,
|
|
996
|
+
"http": "GET /v1/workspaces/{workspace_slug}/roles/{role_id}",
|
|
997
|
+
"idempotent": false,
|
|
998
|
+
"method": "retrieve",
|
|
999
|
+
"paginated": false,
|
|
1000
|
+
"params": null,
|
|
1001
|
+
"poll": null,
|
|
1002
|
+
"public": false,
|
|
1003
|
+
"resource": "workspaces.roles",
|
|
1004
|
+
"scope": null,
|
|
1005
|
+
"signature": "platform.workspaces.roles.retrieve(workspaceSlug, roleId, options?): PlatformAuth.WorkspaceRole",
|
|
1006
|
+
"snippet": "const workspaceRole = await platform.workspaces.roles.retrieve(\"workspace\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\");"
|
|
1007
|
+
},
|
|
1008
|
+
"WorkspaceRoleController_list": {
|
|
1009
|
+
"actor": null,
|
|
1010
|
+
"deprecated": false,
|
|
1011
|
+
"http": "GET /v1/workspaces/{workspace_slug}/roles",
|
|
1012
|
+
"idempotent": false,
|
|
1013
|
+
"method": "list",
|
|
1014
|
+
"paginated": true,
|
|
1015
|
+
"params": "PlatformAuth.WorkspaceRoleListParams",
|
|
1016
|
+
"poll": null,
|
|
1017
|
+
"public": false,
|
|
1018
|
+
"resource": "workspaces.roles",
|
|
1019
|
+
"scope": null,
|
|
1020
|
+
"signature": "platform.workspaces.roles.list(workspaceSlug, params?, options?): PagePromise<PlatformAuth.WorkspaceRole>",
|
|
1021
|
+
"snippet": "for await (const role of platform.workspaces.roles.list(\"workspace\")) {\n console.log(role);\n}\nconst page = await platform.workspaces.roles.list(\"workspace\", {}, { timeout: 5_000 });"
|
|
1022
|
+
},
|
|
1023
|
+
"WorkspaceRoleController_update": {
|
|
1024
|
+
"actor": null,
|
|
1025
|
+
"deprecated": false,
|
|
1026
|
+
"http": "PATCH /v1/workspaces/{workspace_slug}/roles/{role_id}",
|
|
1027
|
+
"idempotent": false,
|
|
1028
|
+
"method": "update",
|
|
1029
|
+
"paginated": false,
|
|
1030
|
+
"params": "PlatformAuth.WorkspaceRoleUpdateParams",
|
|
1031
|
+
"poll": null,
|
|
1032
|
+
"public": false,
|
|
1033
|
+
"resource": "workspaces.roles",
|
|
1034
|
+
"scope": null,
|
|
1035
|
+
"signature": "platform.workspaces.roles.update(workspaceSlug, roleId, params?, options?): PlatformAuth.WorkspaceRole",
|
|
1036
|
+
"snippet": "const workspaceRole = await platform.workspaces.roles.update(\"workspace\", \"5d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6\", { description: \"string\" });"
|
|
1037
|
+
},
|
|
1038
|
+
"WorkspaceServiceController_disable": {
|
|
1039
|
+
"actor": null,
|
|
1040
|
+
"deprecated": false,
|
|
1041
|
+
"http": "DELETE /v1/workspaces/{workspace_slug}/services/{service}",
|
|
1042
|
+
"idempotent": false,
|
|
1043
|
+
"method": "disable",
|
|
1044
|
+
"paginated": false,
|
|
1045
|
+
"params": null,
|
|
1046
|
+
"poll": null,
|
|
1047
|
+
"public": false,
|
|
1048
|
+
"resource": "workspaces.services",
|
|
1049
|
+
"scope": null,
|
|
1050
|
+
"signature": "platform.workspaces.services.disable(workspaceSlug, service, options?): void",
|
|
1051
|
+
"snippet": "await platform.workspaces.services.disable(\"workspace\", \"service\");"
|
|
1052
|
+
},
|
|
1053
|
+
"WorkspaceServiceController_enable": {
|
|
1054
|
+
"actor": null,
|
|
1055
|
+
"deprecated": false,
|
|
1056
|
+
"http": "POST /v1/workspaces/{workspace_slug}/services/{service}",
|
|
1057
|
+
"idempotent": false,
|
|
1058
|
+
"method": "enable",
|
|
1059
|
+
"paginated": false,
|
|
1060
|
+
"params": "PlatformAuth.WorkspaceServiceEnableParams",
|
|
1061
|
+
"poll": null,
|
|
1062
|
+
"public": false,
|
|
1063
|
+
"resource": "workspaces.services",
|
|
1064
|
+
"scope": null,
|
|
1065
|
+
"signature": "platform.workspaces.services.enable(workspaceSlug, service, params?, options?): PlatformAuth.WorkspaceServiceState",
|
|
1066
|
+
"snippet": "const workspaceServiceState = await platform.workspaces.services.enable(\"workspace\", \"service\", { settings: {} });"
|
|
1067
|
+
},
|
|
1068
|
+
"WorkspaceServiceController_list": {
|
|
1069
|
+
"actor": null,
|
|
1070
|
+
"deprecated": false,
|
|
1071
|
+
"http": "GET /v1/workspaces/{workspace_slug}/services",
|
|
1072
|
+
"idempotent": false,
|
|
1073
|
+
"method": "list",
|
|
1074
|
+
"paginated": false,
|
|
1075
|
+
"params": null,
|
|
1076
|
+
"poll": null,
|
|
1077
|
+
"public": false,
|
|
1078
|
+
"resource": "workspaces.services",
|
|
1079
|
+
"scope": null,
|
|
1080
|
+
"signature": "platform.workspaces.services.list(workspaceSlug, options?): PlatformAuth.ListWorkspaceServices",
|
|
1081
|
+
"snippet": "const listWorkspaceServices = await platform.workspaces.services.list(\"workspace\");"
|
|
1082
|
+
},
|
|
1083
|
+
"WorkspaceServiceController_updateSettings": {
|
|
1084
|
+
"actor": null,
|
|
1085
|
+
"deprecated": false,
|
|
1086
|
+
"http": "PATCH /v1/workspaces/{workspace_slug}/services/{service}/settings",
|
|
1087
|
+
"idempotent": false,
|
|
1088
|
+
"method": "updateSettings",
|
|
1089
|
+
"paginated": false,
|
|
1090
|
+
"params": "PlatformAuth.WorkspaceServiceUpdateSettingsParams",
|
|
1091
|
+
"poll": null,
|
|
1092
|
+
"public": false,
|
|
1093
|
+
"resource": "workspaces.services",
|
|
1094
|
+
"scope": null,
|
|
1095
|
+
"signature": "platform.workspaces.services.updateSettings(workspaceSlug, service, params?, options?): PlatformAuth.WorkspaceServiceState",
|
|
1096
|
+
"snippet": "const workspaceServiceState = await platform.workspaces.services.updateSettings(\"workspace\", \"service\", { default_sender: \"noreply@acme.com\" });"
|
|
1097
|
+
},
|
|
1098
|
+
"WorkspaceStatsController_get": {
|
|
1099
|
+
"actor": null,
|
|
1100
|
+
"deprecated": false,
|
|
1101
|
+
"http": "GET /v1/workspaces/{workspace_id}/stats",
|
|
1102
|
+
"idempotent": false,
|
|
1103
|
+
"method": "retrieve",
|
|
1104
|
+
"paginated": false,
|
|
1105
|
+
"params": "PlatformAuth.StatsRetrieveParams",
|
|
1106
|
+
"poll": null,
|
|
1107
|
+
"public": false,
|
|
1108
|
+
"resource": "stats",
|
|
1109
|
+
"scope": null,
|
|
1110
|
+
"signature": "platform.stats.retrieve(params?, options?): PlatformAuth.WorkspaceStats",
|
|
1111
|
+
"snippet": "const workspaceStats = await platform.stats.retrieve();"
|
|
1112
|
+
}
|
|
1113
|
+
},
|
|
1114
|
+
"package": "@productcraft/platform-auth"
|
|
1115
|
+
}
|