@atlasauth/backend 0.7.3 → 0.9.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/CHANGELOG.md +29 -0
- package/README.md +175 -1
- package/dist/client/activity.d.ts +5 -0
- package/dist/client/activity.js.map +1 -1
- package/dist/client/branding.d.ts +58 -0
- package/dist/client/branding.js.map +1 -1
- package/dist/client/domains.d.ts +13 -0
- package/dist/client/domains.js.map +1 -1
- package/dist/client/email-templates.d.ts +1 -1
- package/dist/client/email-templates.js.map +1 -1
- package/dist/client/index.d.ts +55 -2
- package/dist/client/index.js +4 -0
- package/dist/client/index.js.map +1 -1
- package/dist/client/instance.d.ts +201 -0
- package/dist/client/instance.js +38 -0
- package/dist/client/instance.js.map +1 -1
- package/dist/client/logout-notify-endpoints.d.ts +71 -0
- package/dist/client/logout-notify-endpoints.js +34 -0
- package/dist/client/logout-notify-endpoints.js.map +1 -0
- package/dist/client/messaging.d.ts +168 -0
- package/dist/client/messaging.js +45 -0
- package/dist/client/messaging.js.map +1 -1
- package/dist/client/oauth-clients.d.ts +86 -1
- package/dist/client/oauth-clients.js +23 -2
- package/dist/client/oauth-clients.js.map +1 -1
- package/dist/client/platform.d.ts +129 -0
- package/dist/client/platform.js +80 -0
- package/dist/client/platform.js.map +1 -1
- package/dist/client/users.d.ts +29 -1
- package/dist/client/users.js +10 -2
- package/dist/client/users.js.map +1 -1
- package/dist/client/webhooks.d.ts +21 -0
- package/dist/client/webhooks.js.map +1 -1
- package/dist/index.d.ts +4 -2
- package/dist/index.js +15 -1
- package/dist/index.js.map +1 -1
- package/dist/logout-token.d.ts +8 -0
- package/dist/logout-token.js +20 -15
- package/dist/logout-token.js.map +1 -1
- package/dist/oidc.d.ts +225 -0
- package/dist/oidc.js +631 -0
- package/dist/oidc.js.map +1 -0
- package/dist/testing.d.ts +90 -1
- package/dist/testing.js +202 -3
- package/dist/testing.js.map +1 -1
- package/dist/verify.d.ts +21 -0
- package/dist/verify.js +20 -0
- package/dist/verify.js.map +1 -1
- package/dist/webhooks.d.ts +16 -5
- package/dist/webhooks.js +11 -7
- package/dist/webhooks.js.map +1 -1
- package/package.json +1 -1
|
@@ -11,6 +11,11 @@ export interface OAuthClient {
|
|
|
11
11
|
grant_types: string[];
|
|
12
12
|
token_endpoint_auth_method: 'client_secret_basic' | 'client_secret_post' | 'none';
|
|
13
13
|
secret_prefix: string | null;
|
|
14
|
+
/**
|
|
15
|
+
* After a rotation with overlap: when the previous secret stops working (epoch
|
|
16
|
+
* ms). Null when only the current secret is accepted.
|
|
17
|
+
*/
|
|
18
|
+
previous_secret_expires_at?: number | null;
|
|
14
19
|
is_public: boolean;
|
|
15
20
|
first_party: boolean;
|
|
16
21
|
/** Where the client may send users after an RP-initiated logout. */
|
|
@@ -51,6 +56,21 @@ export interface OAuthClientWithSecret extends OAuthClient {
|
|
|
51
56
|
client_secret?: string;
|
|
52
57
|
note: string;
|
|
53
58
|
}
|
|
59
|
+
export interface RotateOAuthClientSecretBody {
|
|
60
|
+
/**
|
|
61
|
+
* How long the previous secret keeps working, in seconds. Default 86400 (24
|
|
62
|
+
* hours); 0 revokes it now (after a leak); at most 604800 (7 days).
|
|
63
|
+
*/
|
|
64
|
+
overlap_seconds?: number;
|
|
65
|
+
}
|
|
66
|
+
/** The rotate response: the new secret (shown once) and when the old one stops working. */
|
|
67
|
+
export interface OAuthClientSecretRotation extends OAuthClientWithSecret {
|
|
68
|
+
client_secret: string;
|
|
69
|
+
/** The overlap applied, in seconds. */
|
|
70
|
+
overlap_seconds: number;
|
|
71
|
+
/** When the previous secret stops working (epoch ms), or null when it already has. */
|
|
72
|
+
previous_secret_expires_at: number | null;
|
|
73
|
+
}
|
|
54
74
|
export interface ClientGrant {
|
|
55
75
|
object: 'client_grant';
|
|
56
76
|
id: string;
|
|
@@ -96,6 +116,63 @@ export interface ImportOAuthClientEntry {
|
|
|
96
116
|
export interface ImportedOAuthClient extends OAuthClient {
|
|
97
117
|
client_secret?: string;
|
|
98
118
|
}
|
|
119
|
+
/**
|
|
120
|
+
* One back-channel logout attempt to a client's `backchannel_logout_uri`.
|
|
121
|
+
* Atlas never follows redirects: a 3xx fails with
|
|
122
|
+
* `error: 'backchannel_redirect_not_followed'` and the `location` it pointed at.
|
|
123
|
+
*/
|
|
124
|
+
export interface BackchannelLogoutDelivery {
|
|
125
|
+
object: 'backchannel_logout_delivery';
|
|
126
|
+
id: string;
|
|
127
|
+
oauth_client_id: string | null;
|
|
128
|
+
/** The ended session (`sid_test_…` for a test); null for "sign out everywhere". */
|
|
129
|
+
sid: string | null;
|
|
130
|
+
/** Sent by `testBackchannelLogout`; never retried. */
|
|
131
|
+
test: boolean;
|
|
132
|
+
status: 'pending' | 'success' | 'failed';
|
|
133
|
+
attempt_number: number;
|
|
134
|
+
max_attempts: number;
|
|
135
|
+
http_status: number | null;
|
|
136
|
+
latency_ms: number | null;
|
|
137
|
+
/**
|
|
138
|
+
* `backchannel_redirect_not_followed`, `backchannel_http_error`,
|
|
139
|
+
* `backchannel_timeout`, `backchannel_network_error` or `backchannel_url_blocked`.
|
|
140
|
+
*/
|
|
141
|
+
error: string | null;
|
|
142
|
+
location: string | null;
|
|
143
|
+
response_snippet: string | null;
|
|
144
|
+
next_retry_at: number | null;
|
|
145
|
+
attempted_at: number | null;
|
|
146
|
+
delivered_at: number | null;
|
|
147
|
+
created_at: number;
|
|
148
|
+
}
|
|
149
|
+
/** A page of {@link BackchannelLogoutDelivery}, newest first. */
|
|
150
|
+
export interface BackchannelLogoutDeliveryPage extends ListPage<BackchannelLogoutDelivery> {
|
|
151
|
+
has_more: boolean;
|
|
152
|
+
/** Pass as `starting_after` for the next page. */
|
|
153
|
+
next_cursor: string | null;
|
|
154
|
+
}
|
|
155
|
+
/** Paging for a delivery log. */
|
|
156
|
+
export interface BackchannelDeliveriesQuery {
|
|
157
|
+
limit?: number;
|
|
158
|
+
starting_after?: string;
|
|
159
|
+
}
|
|
160
|
+
/** The result of a test back-channel logout (a signed token for `sid_test_…` with `atlas_test: true`). */
|
|
161
|
+
export interface BackchannelLogoutTest {
|
|
162
|
+
object: 'backchannel_logout_test';
|
|
163
|
+
delivery_id: string;
|
|
164
|
+
/** True when the receiver answered 2xx. */
|
|
165
|
+
ok: boolean;
|
|
166
|
+
sid: string;
|
|
167
|
+
status: number | null;
|
|
168
|
+
latency_ms: number | null;
|
|
169
|
+
error: string | null;
|
|
170
|
+
location: string | null;
|
|
171
|
+
/** Set when nothing was sent because the URI points at a private, loopback or non-https address. */
|
|
172
|
+
blocked_reason: string | null;
|
|
173
|
+
/** First 512 characters of the response body. */
|
|
174
|
+
body_excerpt: string | null;
|
|
175
|
+
}
|
|
99
176
|
export declare function oauthClientsResource(request: RequestFn): {
|
|
100
177
|
/** Bulk-import OAuth clients for a migration, optionally with pre-hashed secrets. */
|
|
101
178
|
import(body: {
|
|
@@ -105,13 +182,21 @@ export declare function oauthClientsResource(request: RequestFn): {
|
|
|
105
182
|
get(id: string): Promise<OAuthClient>;
|
|
106
183
|
create(body: CreateOAuthClientBody, idempotencyKey?: string): Promise<OAuthClientWithSecret>;
|
|
107
184
|
update(id: string, body: UpdateOAuthClientBody): Promise<OAuthClient>;
|
|
108
|
-
|
|
185
|
+
/**
|
|
186
|
+
* Mint a new secret. The previous one keeps working for `overlap_seconds`
|
|
187
|
+
* (default 24 hours, max 7 days; 0 = revoke it now).
|
|
188
|
+
*/
|
|
189
|
+
rotateSecret(id: string, body?: RotateOAuthClientSecretBody, idempotencyKey?: string): Promise<OAuthClientSecretRotation>;
|
|
109
190
|
delete(id: string): Promise<{
|
|
110
191
|
object: "oauth_client";
|
|
111
192
|
id: string;
|
|
112
193
|
deleted: true;
|
|
113
194
|
note: string;
|
|
114
195
|
}>;
|
|
196
|
+
/** The client's back-channel logout delivery log, newest first. */
|
|
197
|
+
listBackchannelDeliveries(id: string, query?: BackchannelDeliveriesQuery): Promise<BackchannelLogoutDeliveryPage>;
|
|
198
|
+
/** Send a test back-channel logout now and return what the receiver answered. */
|
|
199
|
+
testBackchannelLogout(id: string): Promise<BackchannelLogoutTest>;
|
|
115
200
|
grants: {
|
|
116
201
|
list(clientId: string): Promise<ListPage<ClientGrant>>;
|
|
117
202
|
create(clientId: string, body: {
|
|
@@ -20,12 +20,33 @@ function oauthClientsResource(request) {
|
|
|
20
20
|
update(id, body) {
|
|
21
21
|
return request({ method: 'PATCH', path: `/v1/oauth_clients/${(0, request_1.enc)(id)}`, body });
|
|
22
22
|
},
|
|
23
|
-
|
|
24
|
-
|
|
23
|
+
/**
|
|
24
|
+
* Mint a new secret. The previous one keeps working for `overlap_seconds`
|
|
25
|
+
* (default 24 hours, max 7 days; 0 = revoke it now).
|
|
26
|
+
*/
|
|
27
|
+
rotateSecret(id, body = {}, idempotencyKey) {
|
|
28
|
+
return request({
|
|
29
|
+
method: 'POST',
|
|
30
|
+
path: `/v1/oauth_clients/${(0, request_1.enc)(id)}/rotate_secret`,
|
|
31
|
+
body,
|
|
32
|
+
idempotencyKey,
|
|
33
|
+
});
|
|
25
34
|
},
|
|
26
35
|
delete(id) {
|
|
27
36
|
return request({ method: 'DELETE', path: `/v1/oauth_clients/${(0, request_1.enc)(id)}` });
|
|
28
37
|
},
|
|
38
|
+
/** The client's back-channel logout delivery log, newest first. */
|
|
39
|
+
listBackchannelDeliveries(id, query = {}) {
|
|
40
|
+
return request({
|
|
41
|
+
method: 'GET',
|
|
42
|
+
path: `/v1/oauth_clients/${(0, request_1.enc)(id)}/backchannel_deliveries`,
|
|
43
|
+
query: { ...query },
|
|
44
|
+
});
|
|
45
|
+
},
|
|
46
|
+
/** Send a test back-channel logout now and return what the receiver answered. */
|
|
47
|
+
testBackchannelLogout(id) {
|
|
48
|
+
return request({ method: 'POST', path: `/v1/oauth_clients/${(0, request_1.enc)(id)}/backchannel_logout/test` });
|
|
49
|
+
},
|
|
29
50
|
grants: {
|
|
30
51
|
list(clientId) {
|
|
31
52
|
return request({ method: 'GET', path: `/v1/oauth_clients/${(0, request_1.enc)(clientId)}/grants` });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"oauth-clients.js","sourceRoot":"","sources":["../../src/client/oauth-clients.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"oauth-clients.js","sourceRoot":"","sources":["../../src/client/oauth-clients.ts"],"names":[],"mappings":";;AA8LA,oDAiFC;AA/QD,uCAAgD;AA8LhD,SAAgB,oBAAoB,CAAC,OAAkB;IACrD,OAAO;QACL,qFAAqF;QACrF,MAAM,CACJ,IAA2C,EAC3C,cAAuB;YAEvB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,IAAI;YACF,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,GAAG,CAAC,EAAU;YACZ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1E,CAAC;QACD,MAAM,CAAC,IAA2B,EAAE,cAAuB;YACzD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QACtF,CAAC;QACD,MAAM,CAAC,EAAU,EAAE,IAA2B;YAC5C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAClF,CAAC;QACD;;;WAGG;QACH,YAAY,CACV,EAAU,EACV,OAAoC,EAAE,EACtC,cAAuB;YAEvB,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,gBAAgB;gBAClD,IAAI;gBACJ,cAAc;aACf,CAAC,CAAC;QACL,CAAC;QACD,MAAM,CAAC,EAAU;YACf,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAC7E,CAAC;QACD,mEAAmE;QACnE,yBAAyB,CACvB,EAAU,EACV,QAAoC,EAAE;YAEtC,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,yBAAyB;gBAC3D,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE;aACpB,CAAC,CAAC;QACL,CAAC;QACD,iFAAiF;QACjF,qBAAqB,CAAC,EAAU;YAC9B,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,0BAA0B,EAAE,CAAC,CAAC;QACnG,CAAC;QAED,MAAM,EAAE;YACN,IAAI,CAAC,QAAgB;gBACnB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC;YACvF,CAAC;YACD,MAAM,CACJ,QAAgB,EAChB,IAAuD;gBAEvD,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,QAAQ,CAAC,SAAS;oBACjD,IAAI;iBACL,CAAC,CAAC;YACL,CAAC;YACD,MAAM,CACJ,QAAgB,EAChB,OAAe;gBAEf,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,QAAQ;oBAChB,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,QAAQ,CAAC,WAAW,IAAA,aAAG,EAAC,OAAO,CAAC,EAAE;iBAClE,CAAC,CAAC;YACL,CAAC;SACF;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -1,6 +1,19 @@
|
|
|
1
1
|
import { type AtlasRequestSettings, type RequestFn, type UnknownFieldsEvent } from './request';
|
|
2
2
|
import type { ListPage } from './types';
|
|
3
|
+
import type { BackchannelDeliveriesQuery, BackchannelLogoutDeliveryPage, BackchannelLogoutTest } from './oauth-clients';
|
|
4
|
+
import type { OriginMove, OriginMoveRequest, PreflightFinding } from './instance';
|
|
5
|
+
import type { ConfigChangelogEntry, ListConfigChangelogParams } from './activity';
|
|
3
6
|
import type { AtlasDesign, AtlasDesignPatch, DeletedDesignAsset, DesignAsset, DesignAssetData, DesignPreview, ResolvedAtlasDesign, UploadDesignAssetOptions } from './design';
|
|
7
|
+
/** `GET /v1/platform/atlas_id_apps/{id}/preflight`. */
|
|
8
|
+
export interface AtlasIdAppPreflight {
|
|
9
|
+
object: 'preflight';
|
|
10
|
+
app_id: string;
|
|
11
|
+
/** True when there are no error-severity findings. */
|
|
12
|
+
ok: boolean;
|
|
13
|
+
checked_at: number;
|
|
14
|
+
user_count: number;
|
|
15
|
+
findings: PreflightFinding[];
|
|
16
|
+
}
|
|
4
17
|
/**
|
|
5
18
|
* The platform client: the platform-key (`psk_...`) surface for provisioning and
|
|
6
19
|
* managing apps you own, and for registering Sign in with Atlas apps.
|
|
@@ -27,6 +40,17 @@ export interface PlatformApp {
|
|
|
27
40
|
name: string;
|
|
28
41
|
environment: 'production' | 'development';
|
|
29
42
|
publishable_key: string;
|
|
43
|
+
/** The Frontend API host: the default per-app host, or the custom domain once it is active. */
|
|
44
|
+
frontend_api_host: string | null;
|
|
45
|
+
/**
|
|
46
|
+
* The `iss` this app's session tokens carry. It changes when a custom domain
|
|
47
|
+
* goes active, so read it (and the two URLs below) rather than hard-coding it.
|
|
48
|
+
*/
|
|
49
|
+
issuer: string;
|
|
50
|
+
/** The OpenID discovery document whose `issuer` equals {@link issuer}. */
|
|
51
|
+
discovery_url: string;
|
|
52
|
+
/** The JWKS holding this app's signing keys. */
|
|
53
|
+
jwks_uri: string;
|
|
30
54
|
allowed_origins: string[];
|
|
31
55
|
/** Housekeeping labels (up to 20, each up to 40 chars). */
|
|
32
56
|
tags: string[];
|
|
@@ -201,12 +225,66 @@ export interface AtlasIdApp {
|
|
|
201
225
|
updated_at: number;
|
|
202
226
|
/** On `get` only: people who have approved the app. */
|
|
203
227
|
user_count?: number;
|
|
228
|
+
/** The per-app webhook URL, or null. */
|
|
229
|
+
webhook_url?: string | null;
|
|
230
|
+
webhook_events?: Array<'user.updated' | 'user.deleted' | 'grant.revoked'>;
|
|
231
|
+
/** false once auto-disabled after repeated failures; null without a webhook. */
|
|
232
|
+
webhook_active?: boolean | null;
|
|
204
233
|
}
|
|
205
234
|
/** Create / rotate response: confidential apps carry the client secret exactly once. */
|
|
206
235
|
export interface AtlasIdAppWithSecret extends AtlasIdApp {
|
|
207
236
|
client_secret?: string;
|
|
237
|
+
/** The per-app webhook signing secret, returned exactly once (first set, or rotated). */
|
|
238
|
+
webhook_secret?: string;
|
|
208
239
|
note?: string;
|
|
209
240
|
}
|
|
241
|
+
/** A person who has approved a Sign in with Atlas app (privacy-request lookup). */
|
|
242
|
+
export interface AtlasIdAppUser {
|
|
243
|
+
object: 'atlas_id_user';
|
|
244
|
+
atlas_id_user: true;
|
|
245
|
+
/** The user id as this app sees it (the id_token `sub`). */
|
|
246
|
+
sub: string;
|
|
247
|
+
grant_id: string;
|
|
248
|
+
scopes: string[];
|
|
249
|
+
granted_at: number;
|
|
250
|
+
}
|
|
251
|
+
/** A revoked grant: the app's refresh tokens for the user stop working. */
|
|
252
|
+
export interface AtlasIdGrantRevocation {
|
|
253
|
+
object: 'atlas_id_grant';
|
|
254
|
+
id: string;
|
|
255
|
+
sub: string;
|
|
256
|
+
revoked: true;
|
|
257
|
+
tokens_revoked?: number;
|
|
258
|
+
backchannel_logouts?: number;
|
|
259
|
+
}
|
|
260
|
+
/** The account's Sign in with Atlas publisher (name + DNS-verified domain). */
|
|
261
|
+
export interface AtlasIdPublisher {
|
|
262
|
+
object: 'atlas_id_publisher';
|
|
263
|
+
name: string;
|
|
264
|
+
domain: string;
|
|
265
|
+
verified: boolean;
|
|
266
|
+
verified_at?: number | null;
|
|
267
|
+
/** Publisher-wide consent for verified apps (openid / email / profile only). */
|
|
268
|
+
skip_consent: boolean;
|
|
269
|
+
/** The TXT record to publish. */
|
|
270
|
+
verification: {
|
|
271
|
+
record_name: string;
|
|
272
|
+
record_type: 'TXT';
|
|
273
|
+
record_value: string;
|
|
274
|
+
};
|
|
275
|
+
last_checked_at?: number | null;
|
|
276
|
+
created_at?: number;
|
|
277
|
+
updated_at?: number;
|
|
278
|
+
/** On `verify` only: whether the TXT record matched. */
|
|
279
|
+
record_found?: boolean;
|
|
280
|
+
}
|
|
281
|
+
export interface SetAtlasIdPublisherBody {
|
|
282
|
+
/** Shown on consent screens once verified (up to 100 characters). */
|
|
283
|
+
name: string;
|
|
284
|
+
/** The host your apps' homepage_url lives on, e.g. `example.com`. */
|
|
285
|
+
domain: string;
|
|
286
|
+
skip_consent?: boolean;
|
|
287
|
+
}
|
|
210
288
|
export interface AtlasIdAppList {
|
|
211
289
|
object: 'list';
|
|
212
290
|
data: AtlasIdApp[];
|
|
@@ -241,6 +319,11 @@ export interface CreateAtlasIdAppBody extends AtlasIdAppFields {
|
|
|
241
319
|
export interface UpdateAtlasIdAppBody extends AtlasIdAppFields {
|
|
242
320
|
name?: string;
|
|
243
321
|
redirect_uris?: string[];
|
|
322
|
+
/**
|
|
323
|
+
* Per-app webhook (public https): user.updated, user.deleted and grant.revoked for
|
|
324
|
+
* this app's users. Setting it the first time returns `webhook_secret` once; null removes it.
|
|
325
|
+
*/
|
|
326
|
+
webhook_url?: string | null;
|
|
244
327
|
}
|
|
245
328
|
declare function platformNamespaces(request: RequestFn): {
|
|
246
329
|
apps: {
|
|
@@ -307,9 +390,55 @@ declare function platformNamespaces(request: RequestFn): {
|
|
|
307
390
|
}>;
|
|
308
391
|
/** New client secret, returned exactly once. Public apps have none (409). */
|
|
309
392
|
rotateSecret(id: string): Promise<AtlasIdAppWithSecret>;
|
|
393
|
+
/** The app's back-channel logout delivery log, newest first. */
|
|
394
|
+
listBackchannelDeliveries(id: string, query?: BackchannelDeliveriesQuery): Promise<BackchannelLogoutDeliveryPage>;
|
|
395
|
+
/** Send a test back-channel logout to the app now and return what it answered. */
|
|
396
|
+
testBackchannelLogout(id: string): Promise<BackchannelLogoutTest>;
|
|
397
|
+
/** Check the app's setup (URIs, back-channel delivery, homepage host, legal links, secret age). */
|
|
398
|
+
preflight(id: string): Promise<AtlasIdAppPreflight>;
|
|
399
|
+
/**
|
|
400
|
+
* Privacy requests: is this person one of the app's users? Exact match on a
|
|
401
|
+
* verified email; anyone else gets the same empty list.
|
|
402
|
+
*/
|
|
403
|
+
findUsers(id: string, email: string): Promise<{
|
|
404
|
+
object: "list";
|
|
405
|
+
data: AtlasIdAppUser[];
|
|
406
|
+
}>;
|
|
407
|
+
/** Revoke one user's grant (grant_id from `findUsers`); the next sign-in asks for consent again. */
|
|
408
|
+
revokeGrant(id: string, grantId: string): Promise<AtlasIdGrantRevocation>;
|
|
409
|
+
/** Move the app's URLs from one origin to another. `dry_run: true` writes nothing. */
|
|
410
|
+
moveOrigin(id: string, body: OriginMoveRequest): Promise<OriginMove>;
|
|
411
|
+
/** New per-app webhook signing secret (`webhook_secret`), returned once. 409 without a webhook. */
|
|
412
|
+
rotateWebhookSecret(id: string): Promise<AtlasIdAppWithSecret>;
|
|
310
413
|
/** Preview a design on the Sign in with Atlas page without saving it. */
|
|
311
414
|
previewDesign(design: AtlasDesign): Promise<DesignPreview>;
|
|
312
415
|
};
|
|
416
|
+
/** The account's Sign in with Atlas publisher name and verified domain. */
|
|
417
|
+
atlasIdPublisher: {
|
|
418
|
+
/** 404 until claimed. */
|
|
419
|
+
get(): Promise<AtlasIdPublisher>;
|
|
420
|
+
/** Claim a publisher name and domain; returns the TXT record to publish. */
|
|
421
|
+
set(body: SetAtlasIdPublisherBody): Promise<AtlasIdPublisher>;
|
|
422
|
+
/** Turn publisher-wide consent on or off. */
|
|
423
|
+
update(body: {
|
|
424
|
+
skip_consent: boolean;
|
|
425
|
+
}): Promise<AtlasIdPublisher>;
|
|
426
|
+
delete(): Promise<{
|
|
427
|
+
object: "atlas_id_publisher";
|
|
428
|
+
deleted: true;
|
|
429
|
+
}>;
|
|
430
|
+
/** Look up the TXT record now (`record_found`). */
|
|
431
|
+
verify(): Promise<AtlasIdPublisher>;
|
|
432
|
+
};
|
|
433
|
+
/** Config change history for the account's Sign in with Atlas apps. */
|
|
434
|
+
configChangelog: {
|
|
435
|
+
list(params?: ListConfigChangelogParams): Promise<{
|
|
436
|
+
object: "config_changelog";
|
|
437
|
+
data: ConfigChangelogEntry[];
|
|
438
|
+
has_more?: boolean;
|
|
439
|
+
next_cursor?: string | null;
|
|
440
|
+
}>;
|
|
441
|
+
};
|
|
313
442
|
/** Design images owned by the platform's account, for Sign in with Atlas app designs. */
|
|
314
443
|
designAssets: {
|
|
315
444
|
upload(data: DesignAssetData, options?: UploadDesignAssetOptions): Promise<DesignAsset>;
|
package/dist/client/platform.js
CHANGED
|
@@ -143,6 +143,58 @@ function platformNamespaces(request) {
|
|
|
143
143
|
path: `/v1/platform/atlas_id_apps/${(0, request_1.enc)(id)}/rotate_secret`,
|
|
144
144
|
});
|
|
145
145
|
},
|
|
146
|
+
/** The app's back-channel logout delivery log, newest first. */
|
|
147
|
+
listBackchannelDeliveries(id, query = {}) {
|
|
148
|
+
return request({
|
|
149
|
+
method: 'GET',
|
|
150
|
+
path: `/v1/platform/atlas_id_apps/${(0, request_1.enc)(id)}/backchannel_deliveries`,
|
|
151
|
+
query: { ...query },
|
|
152
|
+
});
|
|
153
|
+
},
|
|
154
|
+
/** Send a test back-channel logout to the app now and return what it answered. */
|
|
155
|
+
testBackchannelLogout(id) {
|
|
156
|
+
return request({
|
|
157
|
+
method: 'POST',
|
|
158
|
+
path: `/v1/platform/atlas_id_apps/${(0, request_1.enc)(id)}/backchannel_logout/test`,
|
|
159
|
+
});
|
|
160
|
+
},
|
|
161
|
+
/** Check the app's setup (URIs, back-channel delivery, homepage host, legal links, secret age). */
|
|
162
|
+
preflight(id) {
|
|
163
|
+
return request({ method: 'GET', path: `/v1/platform/atlas_id_apps/${(0, request_1.enc)(id)}/preflight` });
|
|
164
|
+
},
|
|
165
|
+
/**
|
|
166
|
+
* Privacy requests: is this person one of the app's users? Exact match on a
|
|
167
|
+
* verified email; anyone else gets the same empty list.
|
|
168
|
+
*/
|
|
169
|
+
findUsers(id, email) {
|
|
170
|
+
return request({
|
|
171
|
+
method: 'GET',
|
|
172
|
+
path: `/v1/platform/atlas_id_apps/${(0, request_1.enc)(id)}/users`,
|
|
173
|
+
query: { email },
|
|
174
|
+
});
|
|
175
|
+
},
|
|
176
|
+
/** Revoke one user's grant (grant_id from `findUsers`); the next sign-in asks for consent again. */
|
|
177
|
+
revokeGrant(id, grantId) {
|
|
178
|
+
return request({
|
|
179
|
+
method: 'DELETE',
|
|
180
|
+
path: `/v1/platform/atlas_id_apps/${(0, request_1.enc)(id)}/grants/${(0, request_1.enc)(grantId)}`,
|
|
181
|
+
});
|
|
182
|
+
},
|
|
183
|
+
/** Move the app's URLs from one origin to another. `dry_run: true` writes nothing. */
|
|
184
|
+
moveOrigin(id, body) {
|
|
185
|
+
return request({
|
|
186
|
+
method: 'POST',
|
|
187
|
+
path: `/v1/platform/atlas_id_apps/${(0, request_1.enc)(id)}/move_origin`,
|
|
188
|
+
body,
|
|
189
|
+
});
|
|
190
|
+
},
|
|
191
|
+
/** New per-app webhook signing secret (`webhook_secret`), returned once. 409 without a webhook. */
|
|
192
|
+
rotateWebhookSecret(id) {
|
|
193
|
+
return request({
|
|
194
|
+
method: 'POST',
|
|
195
|
+
path: `/v1/platform/atlas_id_apps/${(0, request_1.enc)(id)}/webhook/rotate_secret`,
|
|
196
|
+
});
|
|
197
|
+
},
|
|
146
198
|
/** Preview a design on the Sign in with Atlas page without saving it. */
|
|
147
199
|
previewDesign(design) {
|
|
148
200
|
return request({
|
|
@@ -152,6 +204,34 @@ function platformNamespaces(request) {
|
|
|
152
204
|
});
|
|
153
205
|
},
|
|
154
206
|
},
|
|
207
|
+
/** The account's Sign in with Atlas publisher name and verified domain. */
|
|
208
|
+
atlasIdPublisher: {
|
|
209
|
+
/** 404 until claimed. */
|
|
210
|
+
get() {
|
|
211
|
+
return request({ method: 'GET', path: '/v1/platform/atlas_id_publisher' });
|
|
212
|
+
},
|
|
213
|
+
/** Claim a publisher name and domain; returns the TXT record to publish. */
|
|
214
|
+
set(body) {
|
|
215
|
+
return request({ method: 'PUT', path: '/v1/platform/atlas_id_publisher', body });
|
|
216
|
+
},
|
|
217
|
+
/** Turn publisher-wide consent on or off. */
|
|
218
|
+
update(body) {
|
|
219
|
+
return request({ method: 'PATCH', path: '/v1/platform/atlas_id_publisher', body });
|
|
220
|
+
},
|
|
221
|
+
delete() {
|
|
222
|
+
return request({ method: 'DELETE', path: '/v1/platform/atlas_id_publisher' });
|
|
223
|
+
},
|
|
224
|
+
/** Look up the TXT record now (`record_found`). */
|
|
225
|
+
verify() {
|
|
226
|
+
return request({ method: 'POST', path: '/v1/platform/atlas_id_publisher/verify' });
|
|
227
|
+
},
|
|
228
|
+
},
|
|
229
|
+
/** Config change history for the account's Sign in with Atlas apps. */
|
|
230
|
+
configChangelog: {
|
|
231
|
+
list(params = {}) {
|
|
232
|
+
return request({ method: 'GET', path: '/v1/platform/config_changelog', query: { ...params } });
|
|
233
|
+
},
|
|
234
|
+
},
|
|
155
235
|
/** Design images owned by the platform's account, for Sign in with Atlas app designs. */
|
|
156
236
|
designAssets: {
|
|
157
237
|
upload(data, options = {}) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"platform.js","sourceRoot":"","sources":["../../src/client/platform.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"platform.js","sourceRoot":"","sources":["../../src/client/platform.ts"],"names":[],"mappings":";;AAipBA,8DAWC;AA5pBD,uCAMmB;AA8WnB,mFAAmF;AAEnF,SAAS,kBAAkB,CAAC,OAAkB;IAC5C,OAAO;QACL,IAAI,EAAE;YACJ,+EAA+E;YAC/E,IAAI,CAAC,SAAiC,EAAE;gBACtC,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,mBAAmB,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;YACrF,CAAC;YACD,iEAAiE;YACjE,MAAM,CAAC,OAA8B,EAAE,EAAE,cAAuB;gBAC9D,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;YACtF,CAAC;YACD,GAAG,CAAC,EAAU;gBACZ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,CAAC,EAAU,EAAE,IAA2B;gBAC5C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YAClF,CAAC;YACD,4EAA4E;YAC5E,MAAM,CACJ,EAAU;gBAEV,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YAC7E,CAAC;YACD,6EAA6E;YAC7E,UAAU,CAAC,GAAa;gBACtB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,+BAA+B,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;YAC3F,CAAC;YACD,+DAA+D;YAC/D,OAAO,CAAC,EAAU;gBAChB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,UAAU,EAAE,CAAC,CAAC;YACnF,CAAC;YACD,SAAS,CAAC,EAAU;gBAClB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC;YACrF,CAAC;YACD;;;eAGG;YACH,YAAY,CACV,EAAU,EACV,OAAqC,EAAE,EACvC,cAAuB;gBAEvB,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,gBAAgB;oBAClD,IAAI;oBACJ,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;YACD,mDAAmD;YACnD,UAAU,CAAC,EAAU;gBACnB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC;YACtF,CAAC;YACD,SAAS,EAAE;gBACT,IAAI,CAAC,KAAa;oBAChB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC;gBACvF,CAAC;gBACD,kFAAkF;gBAClF,MAAM,CACJ,KAAa,EACb,OAAmC,EAAE,EACrC,cAAuB;oBAEvB,OAAO,OAAO,CAAC;wBACb,MAAM,EAAE,MAAM;wBACd,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,KAAK,CAAC,YAAY;wBACjD,IAAI;wBACJ,cAAc;qBACf,CAAC,CAAC;gBACL,CAAC;gBACD,0EAA0E;gBAC1E,YAAY,CACV,KAAa,EACb,UAAkB,EAClB,cAAuB;oBAEvB,OAAO,OAAO,CAAC;wBACb,MAAM,EAAE,MAAM;wBACd,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,KAAK,CAAC,cAAc,IAAA,aAAG,EAAC,UAAU,CAAC,gBAAgB;wBAClF,cAAc;qBACf,CAAC,CAAC;gBACL,CAAC;aACF;YACD,yEAAyE;YACzE,QAAQ,CAAC,EAAU,EAAE,cAAuB;gBAC1C,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,EAAE,CAAC,WAAW;oBAC7C,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;YACD,sDAAsD;YACtD,cAAc,CACZ,aAAqB,EACrB,cAAuB;gBAEvB,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,mCAAmC;oBACzC,IAAI,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE;oBACvC,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;YACD,+EAA+E;YAC/E,KAAK,CAAC,UAAkB,EAAE,cAAuB;gBAC/C,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,yBAAyB;oBAC/B,IAAI,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE;oBACjC,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;SACF;QACD,eAAe,EAAE;YACf,8FAA8F;YAC9F,MAAM,CAAC,OAAiC,EAAE,EAAE,cAAuB;gBACjE,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,+BAA+B;oBACrC,IAAI;oBACJ,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;SACF;QACD,oEAAoE;QACpE,WAAW,EAAE;YACX,IAAI;gBACF,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,4BAA4B,EAAE,CAAC,CAAC;YACxE,CAAC;YACD,sFAAsF;YACtF,MAAM,CAAC,IAA0B,EAAE,cAAuB;gBACxD,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,4BAA4B;oBAClC,IAAI;oBACJ,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;YACD,GAAG,CAAC,EAAU;gBACZ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YACnF,CAAC;YACD,0DAA0D;YAC1D,MAAM,CAAC,EAAU,EAAE,IAA0B;gBAC3C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3F,CAAC;YACD,+CAA+C;YAC/C,MAAM,CAAC,EAAU;gBACf,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YACtF,CAAC;YACD,6EAA6E;YAC7E,YAAY,CAAC,EAAU;gBACrB,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,EAAE,CAAC,gBAAgB;iBAC5D,CAAC,CAAC;YACL,CAAC;YACD,gEAAgE;YAChE,yBAAyB,CACvB,EAAU,EACV,QAAoC,EAAE;gBAEtC,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,EAAE,CAAC,yBAAyB;oBACpE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE;iBACpB,CAAC,CAAC;YACL,CAAC;YACD,kFAAkF;YAClF,qBAAqB,CAAC,EAAU;gBAC9B,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,EAAE,CAAC,0BAA0B;iBACtE,CAAC,CAAC;YACL,CAAC;YACD,mGAAmG;YACnG,SAAS,CAAC,EAAU;gBAClB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC;YAC7F,CAAC;YACD;;;eAGG;YACH,SAAS,CAAC,EAAU,EAAE,KAAa;gBACjC,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,EAAE,CAAC,QAAQ;oBACnD,KAAK,EAAE,EAAE,KAAK,EAAE;iBACjB,CAAC,CAAC;YACL,CAAC;YACD,oGAAoG;YACpG,WAAW,CAAC,EAAU,EAAE,OAAe;gBACrC,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,QAAQ;oBAChB,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,EAAE,CAAC,WAAW,IAAA,aAAG,EAAC,OAAO,CAAC,EAAE;iBACrE,CAAC,CAAC;YACL,CAAC;YACD,sFAAsF;YACtF,UAAU,CAAC,EAAU,EAAE,IAAuB;gBAC5C,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,EAAE,CAAC,cAAc;oBACzD,IAAI;iBACL,CAAC,CAAC;YACL,CAAC;YACD,mGAAmG;YACnG,mBAAmB,CAAC,EAAU;gBAC5B,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,EAAE,CAAC,wBAAwB;iBACpE,CAAC,CAAC;YACL,CAAC;YACD,yEAAyE;YACzE,aAAa,CAAC,MAAmB;gBAC/B,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,2CAA2C;oBACjD,IAAI,EAAE,EAAE,MAAM,EAAE;iBACjB,CAAC,CAAC;YACL,CAAC;SACF;QACD,2EAA2E;QAC3E,gBAAgB,EAAE;YAChB,yBAAyB;YACzB,GAAG;gBACD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,iCAAiC,EAAE,CAAC,CAAC;YAC7E,CAAC;YACD,4EAA4E;YAC5E,GAAG,CAAC,IAA6B;gBAC/B,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,iCAAiC,EAAE,IAAI,EAAE,CAAC,CAAC;YACnF,CAAC;YACD,6CAA6C;YAC7C,MAAM,CAAC,IAA+B;gBACpC,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,iCAAiC,EAAE,IAAI,EAAE,CAAC,CAAC;YACrF,CAAC;YACD,MAAM;gBACJ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,iCAAiC,EAAE,CAAC,CAAC;YAChF,CAAC;YACD,mDAAmD;YACnD,MAAM;gBACJ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,wCAAwC,EAAE,CAAC,CAAC;YACrF,CAAC;SACF;QACD,uEAAuE;QACvE,eAAe,EAAE;YACf,IAAI,CAAC,SAAoC,EAAE;gBAMzC,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,+BAA+B,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;YACjG,CAAC;SACF;QACD,yFAAyF;QACzF,YAAY,EAAE;YACZ,MAAM,CAAC,IAAqB,EAAE,UAAoC,EAAE;gBAClE,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,4BAA4B;oBAClC,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;oBAC7B,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE;iBACpD,CAAC,CAAC;YACL,CAAC;YACD,IAAI;gBACF,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,4BAA4B,EAAE,CAAC,CAAC;YACxE,CAAC;YACD,+DAA+D;YAC/D,MAAM,CAAC,OAAe;gBACpB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,8BAA8B,IAAA,aAAG,EAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YAC3F,CAAC;SACF;KACF,CAAC;AACJ,CAAC;AAUD,SAAgB,yBAAyB,CAAC,MAAiC;IACzE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACvE,CAAC;IACD,MAAM,OAAO,GAAG,IAAA,4BAAkB,EAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC/D,OAAO;QACL,GAAG,kBAAkB,CAAC,OAAO,CAAC;QAC9B,WAAW,CAAC,SAA+B;YACzC,OAAO,yBAAyB,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;QAChE,CAAC;KACF,CAAC;AACJ,CAAC"}
|
package/dist/client/users.d.ts
CHANGED
|
@@ -16,12 +16,33 @@ export interface User {
|
|
|
16
16
|
last_sign_in_at: number | null;
|
|
17
17
|
created_at: number;
|
|
18
18
|
updated_at: number;
|
|
19
|
+
/**
|
|
20
|
+
* Strictly increases with every change to the user; user webhook payloads
|
|
21
|
+
* carry the same value. Apply an update only if its version is higher than
|
|
22
|
+
* the one you hold. (Absent from servers older than this field.)
|
|
23
|
+
*/
|
|
24
|
+
version?: number;
|
|
19
25
|
}
|
|
20
26
|
export interface EmailAddress {
|
|
21
27
|
object: 'email_address';
|
|
22
28
|
id: string;
|
|
23
29
|
email_address: string;
|
|
30
|
+
/**
|
|
31
|
+
* True only when the address was proven (an emailed code or link, a provider
|
|
32
|
+
* that vouches for it, or your backend). An address that signed up while
|
|
33
|
+
* `requireEmailVerification` was false is `false`.
|
|
34
|
+
*/
|
|
24
35
|
verified: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* `status` mirrors `verified`. `strategy` says how it was verified
|
|
38
|
+
* (`email_code`, `email_link`, `oauth`, `admin`, `import`, `scim`, `lti`), or
|
|
39
|
+
* `skipped` for an address held for sign-in but never proven; `null` when not
|
|
40
|
+
* verified. (Absent from servers older than this field.)
|
|
41
|
+
*/
|
|
42
|
+
verification?: {
|
|
43
|
+
status: 'verified' | 'unverified';
|
|
44
|
+
strategy?: string | null;
|
|
45
|
+
};
|
|
25
46
|
primary: boolean;
|
|
26
47
|
created_at: number;
|
|
27
48
|
}
|
|
@@ -92,10 +113,17 @@ export declare function usersResource(request: RequestFn): {
|
|
|
92
113
|
deleted: true;
|
|
93
114
|
}>;
|
|
94
115
|
listSessions(id: string): Promise<ListPage<UserSession>>;
|
|
95
|
-
|
|
116
|
+
/**
|
|
117
|
+
* Revoke every session of the user. `{ revoke_grants: true }` also revokes the
|
|
118
|
+
* user's OAuth grants, so app refresh tokens stop minting access tokens.
|
|
119
|
+
*/
|
|
120
|
+
revokeSessions(id: string, options?: {
|
|
121
|
+
revoke_grants?: boolean;
|
|
122
|
+
}): Promise<{
|
|
96
123
|
object: "user";
|
|
97
124
|
id: string;
|
|
98
125
|
sessions_revoked: number;
|
|
126
|
+
grants_revoked?: number;
|
|
99
127
|
}>;
|
|
100
128
|
addEmail(id: string, body: {
|
|
101
129
|
email_address: string;
|
package/dist/client/users.js
CHANGED
|
@@ -45,8 +45,16 @@ function usersResource(request) {
|
|
|
45
45
|
listSessions(id) {
|
|
46
46
|
return request({ method: 'GET', path: `/v1/users/${(0, request_1.enc)(id)}/sessions` });
|
|
47
47
|
},
|
|
48
|
-
|
|
49
|
-
|
|
48
|
+
/**
|
|
49
|
+
* Revoke every session of the user. `{ revoke_grants: true }` also revokes the
|
|
50
|
+
* user's OAuth grants, so app refresh tokens stop minting access tokens.
|
|
51
|
+
*/
|
|
52
|
+
revokeSessions(id, options = {}) {
|
|
53
|
+
return request({
|
|
54
|
+
method: 'POST',
|
|
55
|
+
path: `/v1/users/${(0, request_1.enc)(id)}/sessions/revoke`,
|
|
56
|
+
...(options.revoke_grants !== undefined ? { body: { revoke_grants: options.revoke_grants } } : {}),
|
|
57
|
+
});
|
|
50
58
|
},
|
|
51
59
|
addEmail(id, body) {
|
|
52
60
|
return request({ method: 'POST', path: `/v1/users/${(0, request_1.enc)(id)}/email_addresses`, body });
|
package/dist/client/users.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/client/users.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/client/users.ts"],"names":[],"mappings":";;AA8FA,sCA2aC;AAzgBD,uCAAgD;AA8FhD,SAAgB,aAAa,CAAC,OAAkB;IAC9C,OAAO;QACL,0CAA0C;QAC1C,IAAI,CAAC,SAA0B,EAAE;YAC/B,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;QAC7E,CAAC;QACD,GAAG,CAAC,EAAU;YACZ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAClE,CAAC;QACD,MAAM,CAAC,IAAoB,EAAE,cAAuB;YAClD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QAC9E,CAAC;QACD,MAAM,CAAC,EAAU,EAAE,IAAoB;YACrC,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1E,CAAC;QACD,wEAAwE;QACxE,eAAe,CAAC,EAAU,EAAE,IAA6B;YACvD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QACjF,CAAC;QACD,GAAG,CAAC,EAAU;YACZ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;QACvE,CAAC;QACD,KAAK,CAAC,EAAU;YACd,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,CAAC,EAAU,EAAE,OAAyC,EAAE;YAC1D,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9E,CAAC;QACD,MAAM,CAAC,EAAU;YACf,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;QAC1E,CAAC;QACD,MAAM,CAAC,EAAU;YACf,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACrE,CAAC;QACD,QAAQ,CAAC,EAAU;YACjB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC;QAC7E,CAAC;QACD,eAAe,CACb,EAAU,EACV,QAAgB;YAEhB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,QAAQ,IAAA,aAAG,EAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1F,CAAC;QACD,YAAY,CAAC,EAAU;YACrB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAC3E,CAAC;QACD;;;WAGG;QACH,cAAc,CACZ,EAAU,EACV,UAAuC,EAAE;YAEzC,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,kBAAkB;gBAC5C,GAAG,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACnG,CAAC,CAAC;QACL,CAAC;QACD,QAAQ,CAAC,EAAU,EAAE,IAA+B;YAClD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC;QACzF,CAAC;QACD,WAAW,CAAC,EAAU,EAAE,OAAe;YACrC,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,oBAAoB,IAAA,aAAG,EAAC,OAAO,CAAC,SAAS;aACpE,CAAC,CAAC;QACL,CAAC;QACD,eAAe,CAAC,EAAU,EAAE,OAAe;YACzC,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,oBAAoB,IAAA,aAAG,EAAC,OAAO,CAAC,UAAU;aACrE,CAAC,CAAC;QACL,CAAC;QACD,sFAAsF;QACtF,mBAAmB,CAAC,EAAU,EAAE,QAAgB;YAC9C,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,wBAAwB,IAAA,aAAG,EAAC,QAAQ,CAAC,EAAE;aAClE,CAAC,CAAC;QACL,CAAC;QACD;;;WAGG;QACH,cAAc,CAAC,EAAU;YACvB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;QAC7E,CAAC;QACD;;;;;WAKG;QACH,YAAY,CACV,EAAU,EACV,IAAmC,EACnC,cAAuB;YAEvB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,aAAa,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QACpG,CAAC;QACD;;;;;;;;WAQG;QACH,sBAAsB,CACpB,EAAU,EACV,IAA8E,EAC9E,cAAuB;YASvB,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,4BAA4B;gBACtD,IAAI;gBACJ,cAAc;aACf,CAAC,CAAC;QACL,CAAC;QACD;;;;WAIG;QACH,cAAc,CACZ,EAAU,EACV,UAAkB;YAElB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,eAAe,IAAA,aAAG,EAAC,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;QACnG,CAAC;QACD,+EAA+E;QAC/E,UAAU,CAAC,EAAU;YACnB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;QACzE,CAAC;QACD;;;;WAIG;QACH,eAAe,CACb,EAAU;YAEV,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD;;;WAGG;QACH,WAAW,CACT,OAAe;YAEf,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,cAAc,IAAA,aAAG,EAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3E,CAAC;QACD;;;;WAIG;QACH,QAAQ,CAAC,IAAuB;YAC9B,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,CAAC;QACD;;;WAGG;QACH,QAAQ,CAAC,EAAU;YACjB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAC3E,CAAC;QACD,6GAA6G;QAC7G,KAAK,CAAC,EAAU;YACd,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QACxE,CAAC;QACD;;;;WAIG;QACH,aAAa,CAAC,EAAU,EAAE,SAAuB,EAAE;YACjD,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,kBAAkB;gBAC5C,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE;aACrB,CAAC,CAAC;QACL,CAAC;QACD;;;;WAIG;QACH,2BAA2B,CACzB,EAAU,EACV,SAAuB,EAAE;YAEzB,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,2BAA2B;gBACrD,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE;aACrB,CAAC,CAAC;QACL,CAAC;QACD;;;WAGG;QACH,WAAW,CAAC,EAAU,EAAE,IAAyB;YAC/C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,sEAAsE;QACtE,kBAAkB,CAAC,EAAU;YAC3B,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACnF,CAAC;QACD,sFAAsF;QACtF,aAAa,CACX,EAAU,EACV,SAAiB;YAEjB,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,aAAa,IAAA,aAAG,EAAC,SAAS,CAAC,EAAE;aACxD,CAAC,CAAC;QACL,CAAC;QACD;;;;WAIG;QACH,cAAc,CAAC,EAAU,EAAE,IAAwB;YACjD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,oBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3F,CAAC;QACD;;;;WAIG;QACH,wBAAwB,CACtB,EAAU,EACV,QAAgB;YAEhB,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,2BAA2B,IAAA,aAAG,EAAC,QAAQ,CAAC,EAAE;aACrE,CAAC,CAAC;QACL,CAAC;QACD;;;;WAIG;QACH,kBAAkB,CAChB,EAAU,EACV,IAAwB,EACxB,cAAuB;YAEvB,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,eAAe;gBACzC,IAAI;gBACJ,cAAc;aACf,CAAC,CAAC;QACL,CAAC;QACD;;;WAGG;QACH,aAAa,CAAC,EAAU;YACtB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACjF,CAAC;QACD,sGAAsG;QACtG,QAAQ,EAAE;YACR,wGAAwG;YACxG,QAAQ,CACN,EAAU,EACV,OAAmC,EAAE,EACrC,cAAuB;gBAEvB,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,WAAW;oBACrC,IAAI;oBACJ,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;YACD,uFAAuF;YACvF,MAAM,CAAC,EAAU,EAAE,cAAuB;gBACxC,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,kBAAkB;oBAC5C,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;YACD,qGAAqG;YACrG,QAAQ,CACN,EAAU,EACV,cAAuB;gBAEvB,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,oBAAoB;oBAC9C,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;SACF;QACD,uEAAuE;QACvE,UAAU,EAAE;YACV,gFAAgF;YAChF,MAAM,CACJ,EAAU,EACV,IAA6B,EAC7B,cAAuB;gBAEvB,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,aAAa;oBACvC,IAAI;oBACJ,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;YACD,qEAAqE;YACrE,IAAI,CAAC,EAAU;gBACb,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;YAChF,CAAC;SACF;QACD,yEAAyE;QACzE,QAAQ,EAAE;YACR,IAAI,CAAC,EAAU;gBACb,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAC3E,CAAC;YACD,wHAAwH;YACxH,MAAM,CACJ,EAAU,EACV,IAA2B,EAC3B,cAAuB;gBAEvB,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,WAAW;oBACrC,IAAI;oBACJ,cAAc;iBACf,CAAC,CAAC;YACL,CAAC;SACF;QACD,sFAAsF;QACtF,gBAAgB,EAAE;YAChB;;;;eAIG;YACH,MAAM,CAAC,EAAU,EAAE,IAAmC;gBACpD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,oBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3F,CAAC;YACD,2EAA2E;YAC3E,GAAG,CAAC,EAAU,EAAE,UAAkB;gBAChC,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,sBAAsB,IAAA,aAAG,EAAC,UAAU,CAAC,EAAE;iBAClE,CAAC,CAAC;YACL,CAAC;SACF;QACD,yDAAyD;QACzD,uBAAuB,EAAE;YACvB,GAAG,CAAC,EAAU;gBACZ,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,2BAA2B;iBACtD,CAAC,CAAC;YACL,CAAC;YACD,iGAAiG;YACjG,MAAM,CACJ,EAAU,EACV,IAA2C;gBAE3C,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,2BAA2B;oBACrD,IAAI;iBACL,CAAC,CAAC;YACL,CAAC;SACF;QACD,wEAAwE;QACxE,YAAY,EAAE;YACZ,yBAAyB;YACzB,GAAG,CAAC,EAAU,EAAE,IAA8B;gBAC5C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC;YACvF,CAAC;YACD,4EAA4E;YAC5E,MAAM,CAAC,EAAU,EAAE,OAAe;gBAChC,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,kBAAkB,IAAA,aAAG,EAAC,OAAO,CAAC,SAAS;iBAClE,CAAC,CAAC;YACL,CAAC;YACD,MAAM,CACJ,EAAU,EACV,OAAe;gBAEf,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,QAAQ;oBAChB,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,kBAAkB,IAAA,aAAG,EAAC,OAAO,CAAC,EAAE;iBAC3D,CAAC,CAAC;YACL,CAAC;SACF;QACD,8BAA8B;QAC9B,WAAW,EAAE;YACX;;;eAGG;YACH,QAAQ,CAAC,EAAU,EAAE,IAA8B;gBACjD,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,EAAE,CAAC,qBAAqB;oBAC/C,IAAI;iBACL,CAAC,CAAC;YACL,CAAC;SACF;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -26,6 +26,14 @@ export interface WebhookDelivery {
|
|
|
26
26
|
payload?: unknown;
|
|
27
27
|
status: string;
|
|
28
28
|
http_status: number | null;
|
|
29
|
+
/**
|
|
30
|
+
* Why the attempt failed: `webhook_redirect_not_followed` (see `location`),
|
|
31
|
+
* `webhook_http_error`, `webhook_timeout`, `webhook_network_error` or
|
|
32
|
+
* `webhook_url_blocked`. Null on success or while pending.
|
|
33
|
+
*/
|
|
34
|
+
error?: string | null;
|
|
35
|
+
/** The absolute `Location` of a 3xx answer. Not followed. */
|
|
36
|
+
location?: string | null;
|
|
29
37
|
response_snippet: string | null;
|
|
30
38
|
next_retry_at: number | null;
|
|
31
39
|
delivered_at: number | null;
|
|
@@ -42,6 +50,15 @@ export interface UpdateWebhookEndpointBody {
|
|
|
42
50
|
enabled_events?: string[];
|
|
43
51
|
active?: boolean;
|
|
44
52
|
}
|
|
53
|
+
/** One subscribable event, described. */
|
|
54
|
+
export interface WebhookEventCatalogEntry {
|
|
55
|
+
name: string;
|
|
56
|
+
description: string;
|
|
57
|
+
/** Who should act on it, e.g. `rp_sessions`, `rp_accounts`, `dsar`. Empty: no relying party needs it. */
|
|
58
|
+
relevant_for: string[];
|
|
59
|
+
/** Set on a superseded spelling: subscribe to this event instead. */
|
|
60
|
+
deprecated_alias_of?: string;
|
|
61
|
+
}
|
|
45
62
|
/** The endpoint list plus the delivery settings that apply to every endpoint. */
|
|
46
63
|
export interface WebhookEndpointList {
|
|
47
64
|
object?: 'list';
|
|
@@ -50,6 +67,10 @@ export interface WebhookEndpointList {
|
|
|
50
67
|
next_cursor?: string | null;
|
|
51
68
|
/** Every event type an endpoint can subscribe to. */
|
|
52
69
|
available_events?: string[];
|
|
70
|
+
/** The same events as `available_events`, each described. */
|
|
71
|
+
event_catalog?: WebhookEventCatalogEntry[];
|
|
72
|
+
/** Every value `relevant_for` can hold. */
|
|
73
|
+
event_audiences?: string[];
|
|
53
74
|
/** The delay before each retry, in milliseconds. */
|
|
54
75
|
retry_schedule_ms?: number[];
|
|
55
76
|
/** Delivery attempts per event before it is marked failed. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/client/webhooks.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/client/webhooks.ts"],"names":[],"mappings":";;AA2GA,4CA4DC;AAvKD,uCAAgD;AA2GhD,SAAgB,gBAAgB,CAAC,OAAkB;IACjD,OAAO;QACL,SAAS,EAAE;YACT,IAAI;gBACF,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAC;YACnE,CAAC;YACD,wEAAwE;YACxE,MAAM,CAAC,EAAU,EAAE,IAA+B;gBAChD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,yBAAyB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YACtF,CAAC;YACD,sDAAsD;YACtD,YAAY,CAAC,EAAU;gBACrB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,IAAA,aAAG,EAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAC;YAC7F,CAAC;YACD,uEAAuE;YACvE,YAAY,CAAC,EAAU;gBACrB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,IAAA,aAAG,EAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAC;YAC7F,CAAC;YACD,mEAAmE;YACnE,IAAI,CAAC,EAAU;gBACb,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,IAAA,aAAG,EAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YACpF,CAAC;YACD,+EAA+E;YAC/E,SAAS,CAAC,EAAU,EAAE,UAAkB;gBACtC,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,yBAAyB,IAAA,aAAG,EAAC,EAAE,CAAC,eAAe,IAAA,aAAG,EAAC,UAAU,CAAC,YAAY;iBACjF,CAAC,CAAC;YACL,CAAC;YACD,MAAM,CACJ,IAA+B,EAC/B,cAAuB;gBAEvB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;YAC1F,CAAC;YACD,MAAM,CACJ,EAAU;gBAEV,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,yBAAyB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YACjF,CAAC;SACF;QACD,oCAAoC;QACpC,UAAU,CACR,EAAU,EACV,SAAsC,EAAE;YAExC,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,yBAAyB,IAAA,aAAG,EAAC,EAAE,CAAC,aAAa;gBACnD,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE;aACrB,CAAC,CAAC;QACL,CAAC;QACD,8DAA8D;QAC9D,SAAS,CAAC,UAAkB,EAAE,UAAkB;YAC9C,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,yBAAyB,IAAA,aAAG,EAAC,UAAU,CAAC,eAAe,IAAA,aAAG,EAAC,UAAU,CAAC,YAAY;aACzF,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}
|