SignerEndpoints

1
type SignerEndpoints = [
2
  {
3
    Body:
4
      | (Omit<EmailAuthParams, "redirectParams"> & object)
5
      | SmsAuthParams
6
      | {
7
          passkey: {
8
            attestation: Awaited<ReturnType<typeof getWebAuthnAttestation>>;
9
            challenge: string;
10
          };
11
        }
12
      | AccessKeyAuthParamsPublicKeyOnly;
13
    Response: SignupResponse;
14
    Route: "/v1/signup";
15
  },
16
  {
17
    Body: {
18
      stampedRequest: TSignedRequest;
19
    };
20
    Response: User;
21
    Route: "/v1/whoami";
22
  },
23
  {
24
    Body: (Omit<EmailAuthParams, "redirectParams"> & object) | SmsAuthParams;
25
    Response: {
26
      multiFactors?: MfaFactor[];
27
      orgId: string;
28
      otpId?: string;
29
    };
30
    Route: "/v1/auth";
31
  },
32
  {
33
    Body: {
34
      accessKey?: {
35
        accountId?: string;
36
        publicKey: string;
37
      };
38
      email?: string;
39
      phone?: string;
40
    };
41
    Response: {
42
      orgId: string | null;
43
    };
44
    Route: "/v1/lookup";
45
  },
46
  {
47
    Body: {
48
      contact: string;
49
      otpType: "OTP_TYPE_SMS" | "OTP_TYPE_EMAIL";
50
    };
51
    Response: {
52
      otpId: string;
53
    };
54
    Route: "/v1/init-otp";
55
  },
56
  {
57
    Body: {
58
      otpCode: string;
59
      otpId: string;
60
    };
61
    Response: {
62
      verificationToken: string;
63
    };
64
    Route: "/v1/verify-otp";
65
  },
66
  {
67
    Body: {
68
      stampedRequest: TSignedRequest;
69
    };
70
    Response: {
71
      signature: Hex;
72
    };
73
    Route: "/v1/sign-payload";
74
  },
75
  {
76
    Body: {
77
      stampedRequest: TSignedRequest;
78
    };
79
    Response: void;
80
    Route: "/v1/update-email-auth";
81
  },
82
  {
83
    Body: {
84
      stampedRequest: TSignedRequest;
85
    };
86
    Response: void;
87
    Route: "/v1/update-phone-auth";
88
  },
89
  {
90
    Body: {
91
      stampedRequest: TSignedRequest;
92
    };
93
    Response: {
94
      oauthProviders: OauthProviderInfo[];
95
    };
96
    Route: "/v1/add-oauth-provider";
97
  },
98
  {
99
    Body: {
100
      stampedRequest: TSignedRequest;
101
    };
102
    Response: void;
103
    Route: "/v1/remove-oauth-provider";
104
  },
105
  {
106
    Body: {};
107
    Response: AuthMethods;
108
    Route: "/v1/list-auth-methods";
109
  },
110
  {
111
    Body: {
112
      nonce: string;
113
    };
114
    Response: OauthConfig;
115
    Route: "/v1/prepare-oauth";
116
  },
117
  {
118
    Body: OtpParams;
119
    Response: OtpResponse;
120
    Route: "/v1/otp";
121
  },
122
  {
123
    Body: {
124
      stampedRequest: TSignedRequest;
125
    };
126
    Response: {
127
      multiFactors: MfaFactor[];
128
    };
129
    Route: "/v1/auth-list-multi-factors";
130
  },
131
  {
132
    Body: {
133
      multiFactorIds: string[];
134
      stampedRequest: TSignedRequest;
135
    };
136
    Response: {
137
      multiFactors: MfaFactor[];
138
    };
139
    Route: "/v1/auth-delete-multi-factors";
140
  },
141
  {
142
    Body: {
143
      multiFactorType: MultiFactorType;
144
      stampedRequest: TSignedRequest;
145
    };
146
    Response: AddMfaResult;
147
    Route: "/v1/auth-request-multi-factor";
148
  },
149
  {
150
    Body: VerifyMfaParams & object;
151
    Response: {
152
      multiFactors: MfaFactor[];
153
    };
154
    Route: "/v1/auth-verify-multi-factor";
155
  },
156
  {
157
    Body: JwtParams;
158
    Response: JwtResponse;
159
    Route: "/v1/auth-jwt";
160
  },
161
  {
162
    Body: {};
163
    Response: SignerConfig;
164
    Route: "/v1/signer-config";
165
  },
166
  {
167
    Body: {
168
      encryptedPayload: string;
169
      multiFactors: VerifyMfaParams[];
170
    };
171
    Response: {
172
      multiFactors: MfaFactor[];
173
      payload: {
174
        credentialBundle?: string;
175
      };
176
    };
177
    Route: "/v1/auth-validate-multi-factors";
178
  },
179
  {
180
    Body: {
181
      members: object[];
182
    };
183
    Response: {
184
      result: {
185
        evmSignerAddress: Address;
186
        members: object[];
187
        orgId: string;
188
      };
189
    };
190
    Route: "/v1/multi-owner-create";
191
  },
192
  {
193
    Body: {
194
      members: object[];
195
      organizationId: string;
196
    };
197
    Response: {
198
      result: TurnkeyApiTypes["v1CreateUsersRequest"];
199
    };
200
    Route: "/v1/multi-owner-prepare-add";
201
  },
202
  {
203
    Body: {
204
      stampedRequest: TSignedRequest;
205
    };
206
    Response: {
207
      result: {
208
        members: object[];
209
        updateRootQuorumRequest: TurnkeyApiTypes["v1UpdateRootQuorumRequest"];
210
      };
211
    };
212
    Route: "/v1/multi-owner-add";
213
  },
214
  {
215
    Body: {
216
      stampedRequest: TSignedRequest;
217
    };
218
    Response: {
219
      result: TurnkeyApiTypes["v1UpdateRootQuorumResult"];
220
    };
221
    Route: "/v1/multi-owner-update-root-quorum";
222
  },
223
  {
224
    Body: {
225
      stampedRequest: TSignedRequest;
226
    };
227
    Response: {
228
      result: {
229
        signRawPayloadResult: TurnkeyApiTypes["v1SignRawPayloadResult"];
230
      };
231
    };
232
    Route: "/v1/multi-owner-sign-raw-payload";
233
  },
234
  {
235
    Body: {
236
      members: object[];
237
      organizationId: string;
238
    };
239
    Response: {
240
      result: {
241
        deleteMembersRequest: TurnkeyApiTypes["v1DeleteUsersRequest"];
242
        updateRootQuorumRequest: TurnkeyApiTypes["v1UpdateRootQuorumRequest"];
243
      };
244
    };
245
    Route: "/v1/multi-owner-prepare-delete";
246
  },
247
  {
248
    Body: {
249
      stampedRequest: TSignedRequest;
250
    };
251
    Response: {
252
      result: {
253
        deletedUserIds: string[];
254
      };
255
    };
256
    Route: "/v1/multi-owner-delete";
257
  },
258
];