auth0-types/src/postChallengeEvent.ts at main · Kpler/auth0-types · GitHub

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
// https://auth0.com/docs/customize/actions/explore-triggers/password-reset-triggers/post-challenge-trigger/post-challenge-event-object

import type {
  Dictionary,
  EventAuthorization,
  EventBaseAuthenticationMethod,
  EventBaseRequest,
  EventBaseTransaction,
  EventClient,
  EventConnection,
  EventOrganization,
  EventStats,
  EventTenant,
  EventUser,
} from "./shared";

type ApiMfaFactorType =
  | "otp"
  | "recovery-code"
  | "email"
  | "webauthn-platform"
  | "webauthn-roaming"
  | "push-notification"
  | "phone";

type AuthenticationMethod = EventBaseAuthenticationMethod & {
  // only set for "mfa"
  type?: ApiMfaFactorType;
};

type Request = EventBaseRequest & {
  body: Dictionary;
  query: Dictionary;
};

type User = Pick<
  EventUser,
  | "app_metadata"
  | "created_at"
  | "email"
  | "email_verified"
  | "enrolledFactors"
  | "family_name"
  | "given_name"
  | "identities"
  | "last_password_reset"
  | "name"
  | "phone_number"
  | "phone_verified"
  | "user_id"
  | "username"
  | "nickname"
  | "picture"
  | "updated_at"
  | "user_metadata"
>;

export type PostChallengeUser = User;

export type PostChallengeEvent = {
  authentication: {
    methods: AuthenticationMethod[];
  };
  authorization: EventAuthorization;
  client: EventClient;
  connection: EventConnection;
  organization?: EventOrganization;
  request: Request;
  stats: EventStats;
  tenant: EventTenant;
  transaction: Pick<
    EventBaseTransaction,
    "locale" | "login_hint" | "state" | "ui_locales"
  >;
  user: User;
};