Repository navigation
Expand file tree
/
Copy pathadmin.ts
More file actions
365 lines (326 loc) · 10.6 KB
/
Copy pathadmin.ts
File metadata and controls
365 lines (326 loc) · 10.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
import {
AdminOrganizationListResponseSchema,
AdminUserDetailResponseSchema,
ApiUserSchema,
AuthEventSchema,
CredentialResponseSchema,
DeviceReplacementRecoveryResponseSchema,
OrganizationMembersResponseSchema,
OrganizationMembershipSchema,
OrganizationSchema,
SessionSchema,
UsersListResponseSchema,
type AddOrganizationMemberRequest,
type CreateOrganizationRequest,
type DeviceReplacementRecoveryResponse,
type UpdateOrganizationMemberRequest,
type UpdateOrganizationRequest,
} from "@seamless-auth/types";
import { z } from "zod";
import type { AuthClient } from "./authClient.js";
import type { ApiResponse } from "./http.js";
import { PermissionError } from "./systemConfig.js";
export { PermissionError };
export class AdminApiError extends Error {
constructor(message: string) {
super(message);
this.name = "AdminApiError";
}
}
// Responses are parsed with the shared schemas, loosened so a key the schema does
// not know is kept rather than stripped or, for the strict user schema, rejected.
// An instance newer than this CLI's types then still lists, and `--json` prints
// everything the instance sent.
const UserSchema = ApiUserSchema.loose();
const MembershipSchema = OrganizationMembershipSchema.extend({
user: OrganizationMembershipSchema.shape.user.unwrap().loose().optional(),
}).loose();
const OrgSchema = OrganizationSchema.extend({
membership: MembershipSchema.optional(),
}).loose();
const UserListSchema = UsersListResponseSchema.extend({
users: z.array(UserSchema),
});
const UserDetailSchema = AdminUserDetailResponseSchema.extend({
user: UserSchema,
sessions: z.array(SessionSchema.loose()),
credentials: z.array(CredentialResponseSchema.loose()),
events: z.array(AuthEventSchema.loose()),
});
const OrgListSchema = AdminOrganizationListResponseSchema.extend({
organizations: z.array(OrgSchema),
});
const MemberListSchema = OrganizationMembersResponseSchema.extend({
members: z.array(MembershipSchema),
});
export type AdminUser = z.infer<typeof UserSchema>;
export type AdminCredential = z.infer<typeof CredentialResponseSchema>;
export type AdminOrganization = z.infer<typeof OrgSchema>;
export type AdminMembership = z.infer<typeof MembershipSchema>;
function parse<T>(schema: z.ZodType<T>, data: unknown, what: string): T {
const parsed = schema.safeParse(data);
if (!parsed.success) {
const issue = parsed.error.issues[0];
const where = issue.path.join(".") || "response";
throw new AdminApiError(
`The instance returned ${what} this CLI cannot read (${where}: ${issue.message}).`,
);
}
return parsed.data;
}
function apiMessage(data: unknown): string | undefined {
if (data && typeof data === "object") {
const record = data as Record<string, unknown>;
for (const value of [record.error, record.message]) {
if (typeof value === "string" && value.trim()) {
return value.trim().replace(/\.$/, "");
}
}
}
return undefined;
}
function apiError(res: ApiResponse<unknown>, summary: string): AdminApiError {
const detail = apiMessage(res.data);
return new AdminApiError(
`${summary} (${res.status}${detail ? `: ${detail}` : ""}).`,
);
}
async function call<T>(
client: AuthClient,
method: string,
path: string,
body?: unknown,
): Promise<ApiResponse<T>> {
let res: ApiResponse<T>;
if (method === "GET") {
res = await client.get<T>(path);
} else {
const init: RequestInit = { method };
if (body !== undefined) {
init.headers = { "Content-Type": "application/json" };
init.body = JSON.stringify(body);
}
res = await client.request<T>(path, init);
}
if (res.status === 403) throw new PermissionError();
return res;
}
// Users
export type UserList = z.infer<typeof UserListSchema>;
export interface ListUsersOptions {
limit?: number;
offset?: number;
}
export async function listUsers(
client: AuthClient,
opts: ListUsersOptions = {},
): Promise<UserList> {
const query = new URLSearchParams();
if (opts.limit !== undefined) query.set("limit", String(opts.limit));
if (opts.offset !== undefined) query.set("offset", String(opts.offset));
const suffix = query.size ? `?${query}` : "";
const res = await call<unknown>(client, "GET", `/admin/users${suffix}`);
if (!res.ok) throw apiError(res, "Could not list users");
// `total` counts every user, not just this page, so callers can report position.
return parse(UserListSchema, res.data, "a user list");
}
export async function deleteUser(client: AuthClient, id: string): Promise<void> {
const res = await call(client, "DELETE", "/admin/users", { userId: id });
if (res.status === 404) throw apiError(res, `No user found with id ${id}`);
if (!res.ok) throw apiError(res, "Could not delete user");
}
export type UserDetail = z.infer<typeof UserDetailSchema>;
export async function getUserDetail(
client: AuthClient,
id: string,
): Promise<UserDetail> {
const res = await call<unknown>(
client,
"GET",
`/admin/users/${encodeURIComponent(id)}`,
);
if (res.status === 404) throw apiError(res, `No user found with id ${id}`);
if (!res.ok) throw apiError(res, "Could not load user");
return parse(UserDetailSchema, res.data, "a user");
}
export interface DeviceReplacementOptions {
revokeSessions: boolean;
removePasskeys: boolean;
disableTotp: boolean;
}
export async function prepareDeviceReplacement(
client: AuthClient,
id: string,
opts: DeviceReplacementOptions,
): Promise<DeviceReplacementRecoveryResponse> {
const res = await client.request<unknown>(
`/admin/users/${encodeURIComponent(id)}/recovery/device-replacement`,
{
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(opts),
},
);
if (res.status === 404) throw apiError(res, `No user found with id ${id}`);
if (res.status === 401 || res.status === 403) {
throw new PermissionError(
"Admin-assisted device replacement requires an elevated step-up admin session, which the CLI cannot establish yet. Use the dashboard for this action.",
);
}
if (!res.ok) throw apiError(res, "Could not prepare device replacement");
return parse(
DeviceReplacementRecoveryResponseSchema,
res.data,
"a device replacement result",
);
}
// Organizations
export type OrgList = z.infer<typeof OrgListSchema>;
export interface ListOrgsOptions {
limit?: number;
offset?: number;
search?: string;
}
export async function listOrgs(
client: AuthClient,
opts: ListOrgsOptions = {},
): Promise<OrgList> {
const query = new URLSearchParams();
if (opts.limit !== undefined) query.set("limit", String(opts.limit));
if (opts.offset !== undefined) query.set("offset", String(opts.offset));
if (opts.search) query.set("search", opts.search);
const suffix = query.size ? `?${query}` : "";
const res = await call<unknown>(client, "GET", `/admin/organizations${suffix}`);
if (!res.ok) throw apiError(res, "Could not list organizations");
// `total` counts every match, not just this page, so callers can report position.
return parse(OrgListSchema, res.data, "an organization list");
}
function orgEnvelope(
res: ApiResponse<unknown>,
summary: string,
): AdminOrganization {
if (!res.ok) throw apiError(res, summary);
return parse(
z.object({ organization: OrgSchema }),
res.data,
"an organization",
).organization;
}
export async function createOrg(
client: AuthClient,
body: CreateOrganizationRequest,
): Promise<AdminOrganization> {
const res = await call<unknown>(
client,
"POST",
"/admin/organizations",
body,
);
return orgEnvelope(res, "Could not create organization");
}
export async function getOrg(
client: AuthClient,
id: string,
): Promise<AdminOrganization> {
const res = await call<unknown>(
client,
"GET",
`/admin/organizations/${encodeURIComponent(id)}`,
);
if (res.status === 404) {
throw apiError(res, `No organization found with id ${id}`);
}
return orgEnvelope(res, "Could not load organization");
}
export async function updateOrg(
client: AuthClient,
id: string,
body: UpdateOrganizationRequest,
): Promise<AdminOrganization> {
const res = await call<unknown>(
client,
"PATCH",
`/admin/organizations/${encodeURIComponent(id)}`,
body,
);
if (res.status === 404) {
throw apiError(res, `No organization found with id ${id}`);
}
return orgEnvelope(res, "Could not update organization");
}
export type MemberList = z.infer<typeof MemberListSchema>;
export async function listMembers(
client: AuthClient,
orgId: string,
): Promise<MemberList> {
const res = await call<unknown>(
client,
"GET",
`/admin/organizations/${encodeURIComponent(orgId)}/members`,
);
if (res.status === 404) {
throw apiError(res, `No organization found with id ${orgId}`);
}
if (!res.ok) throw apiError(res, "Could not list members");
return parse(MemberListSchema, res.data, "a member list");
}
function membershipEnvelope(
res: ApiResponse<unknown>,
summary: string,
): AdminMembership {
if (!res.ok) throw apiError(res, summary);
return parse(
z.object({ membership: MembershipSchema }),
res.data,
"a membership",
).membership;
}
export async function addMember(
client: AuthClient,
orgId: string,
body: AddOrganizationMemberRequest,
): Promise<AdminMembership> {
const res = await call<unknown>(
client,
"POST",
`/admin/organizations/${encodeURIComponent(orgId)}/members`,
body,
);
// The API answers 404 for a missing user as well as a missing organization.
if (res.status === 404) throw apiError(res, "No such organization or user");
if (res.status === 409) {
throw apiError(
res,
`That user is already a member of organization ${orgId}`,
);
}
return membershipEnvelope(res, "Could not add member");
}
export async function updateMember(
client: AuthClient,
orgId: string,
userId: string,
body: UpdateOrganizationMemberRequest,
): Promise<AdminMembership> {
const res = await call<unknown>(
client,
"PATCH",
`/admin/organizations/${encodeURIComponent(orgId)}/members/${encodeURIComponent(userId)}`,
body,
);
if (res.status === 404) throw apiError(res, "No such organization or member");
return membershipEnvelope(res, "Could not update member");
}
export async function removeMember(
client: AuthClient,
orgId: string,
userId: string,
): Promise<void> {
const res = await call(
client,
"DELETE",
`/admin/organizations/${encodeURIComponent(orgId)}/members/${encodeURIComponent(userId)}`,
);
if (res.status === 404) throw apiError(res, "No such organization or member");
if (!res.ok) throw apiError(res, "Could not remove member");
}