@@ -42,205 +42,3 @@ Clerk SDKs expose an instance of the Clerk Backend SDK for use in server environ
42
42
```
43
43
</Tab >
44
44
</Tabs >
45
-
46
- ## User operations
47
-
48
- User operations are exposed under ` clerkClient.users ` . The following methods are available:
49
-
50
- ### User ` get ` operations
51
-
52
- - [ ` getUserList() ` ] ( /docs/references/backend/user/get-user-list )
53
- - [ ` getUser() ` ] ( /docs/references/backend/user/get-user )
54
- - [ ` getCount() ` ] ( /docs/references/backend/user/get-count )
55
- - [ ` getOrganizationMembershipList() ` ] ( /docs/references/backend/user/get-organization-membership-list )
56
- - [ ` getUserOauthAccessToken() ` ] ( /docs/references/backend/user/get-user-oauth-access-token )
57
-
58
- ### User ` create ` operations
59
-
60
- - [ ` createUser() ` ] ( /docs/references/backend/user/create-user )
61
- - [ ` verifyPassword() ` ] ( /docs/references/backend/user/verify-password )
62
- - [ ` banUser() ` ] ( /docs/references/backend/user/ban-user )
63
- - [ ` unbanUser() ` ] ( /docs/references/backend/user/unban-user )
64
- - [ ` lockUser() ` ] ( /docs/references/backend/user/lock-user )
65
- - [ ` unlockUser() ` ] ( /docs/references/backend/user/unlock-user )
66
-
67
- ### User ` update ` operations
68
-
69
- - [ ` updateUser() ` ] ( /docs/references/backend/user/update-user )
70
- - [ ` updateUserMetadata() ` ] ( /docs/references/backend/user/update-user-metadata )
71
-
72
- ### User ` delete ` operations
73
-
74
- - [ ` deleteUser() ` ] ( /docs/references/backend/user/delete-user )
75
- - [ ` disableUserMFA() ` ] ( /docs/references/backend/user/disable-user-mfa )
76
-
77
- ## Organization operations
78
-
79
- Organization operations are exposed under ` clerkClient.organizations ` . The following methods are available:
80
-
81
- ### Organization ` get ` operations
82
-
83
- - [ ` getOrganization() ` ] ( /docs/references/backend/organization/get-organization )
84
- - [ ` getOrganizationList() ` ] ( /docs/references/backend/organization/get-organization-list )
85
- - [ ` getOrganizationMembershipList() ` ] ( /docs/references/backend/organization/get-organization-membership-list )
86
- - [ ` getOrganizationInvitationList() ` ] ( /docs/references/backend/organization/get-organization-invitation-list )
87
-
88
- ### Organization ` create ` operations
89
-
90
- - [ ` createOrganization() ` ] ( /docs/references/backend/organization/create-organization )
91
- - [ ` createOrganizationMembership() ` ] ( /docs/references/backend/organization/create-organization-membership )
92
- - [ ` createOrganizationInvitation() ` ] ( /docs/references/backend/organization/create-organization-invitation )
93
-
94
- ### Organization ` update ` operations
95
-
96
- - [ ` updateOrganization() ` ] ( /docs/references/backend/organization/update-organization )
97
- - [ ` updateOrganizationMembership() ` ] ( /docs/references/backend/organization/update-organization-membership )
98
- - [ ` updateOrganizationMetadata() ` ] ( /docs/references/backend/organization/update-organization-metadata )
99
- - [ ` updateOrganizationMembershipMetadata() ` ] ( /docs/references/backend/organization/update-organization-membership-metadata )
100
-
101
- ### Organization ` delete ` operations
102
-
103
- - [ ` deleteOrganization() ` ] ( /docs/references/backend/organization/delete-organization )
104
- - [ ` deleteOrganizationMembership() ` ] ( /docs/references/backend/organization/delete-organization-membership )
105
- - [ ` revokeOrganizationInvitation() ` ] ( /docs/references/backend/organization/revoke-organization-invitation )
106
-
107
- ## Allowlist Identifiers operations
108
-
109
- Allowlist Identifiers operations are exposed under ` clerkClient.allowlistIdentifiers ` . The following methods are available:
110
-
111
- ### Allowlist Identifiers ` get ` operations
112
-
113
- - [ ` getAllowlistIdentifierList() ` ] ( /docs/references/backend/allowlist/get-allowlist-identifier-list )
114
-
115
- ### Allowlist Identifiers ` create ` operations
116
-
117
- - [ ` createAllowlistIdentifier() ` ] ( /docs/references/backend/allowlist/create-allowlist-identifier )
118
-
119
- ### Allowlist Identifiers ` delete ` operations
120
-
121
- - [ ` deleteAllowlistIdentifier() ` ] ( /docs/references/backend/allowlist/delete-allowlist-identifier )
122
-
123
- ## Session operations
124
-
125
- Session operations are exposed under ` clerkClient.sessions ` . The following methods are available:
126
-
127
- ### Session ` get ` operations
128
-
129
- - [ ` getSession() ` ] ( /docs/references/backend/sessions/get-session )
130
- - [ ` getSessionList() ` ] ( /docs/references/backend/sessions/get-session-list )
131
- - [ ` getToken() ` ] ( /docs/references/backend/sessions/get-token )
132
- - [ ` authenticateRequest() ` ] ( /docs/references/backend/sessions/authenticate-request )
133
- - [ ` verifySession() ` (deprecated)] ( /docs/references/backend/sessions/verify-session )
134
-
135
- ### Session ` delete ` operations
136
-
137
- - [ ` revokeSession() ` ] ( /docs/references/backend/sessions/revoke-session )
138
-
139
- ## Client operations
140
-
141
- Client operations are exposed under ` clerkClient.clients ` . The following methods are available:
142
-
143
- ### Client ` get ` operations
144
-
145
- - [ ` getClient() ` ] ( /docs/references/backend/client/get-client )
146
- - [ ` getClientList() ` (deprecated)] ( /docs/references/backend/client/get-client-list )
147
- - [ ` verifyClient() ` ] ( /docs/references/backend/client/verify-client )
148
-
149
- ## Invitation operations
150
-
151
- Invitation operations are exposed under ` clerkClient.invitations ` . The following methods are available:
152
-
153
- ### Invitation ` get ` operations
154
-
155
- - [ ` getInvitationList() ` ] ( /docs/references/backend/invitations/get-invitation-list )
156
-
157
- ### Invitation ` create ` operations
158
-
159
- - [ ` createInvitation() ` ] ( /docs/references/backend/invitations/create-invitation )
160
-
161
- ### Invitation ` delete ` operations
162
-
163
- - [ ` revokeInvitation() ` ] ( /docs/references/backend/invitations/revoke-invitation )
164
-
165
- ## Redirect URL operations
166
-
167
- Redirect URLs are whitelisted URLs that facilitate secure authentication flows in native applications (e.g. React Native, Expo). In these contexts, Clerk ensures that security-critical nonces are passed only to the whitelisted URLs.
168
-
169
- Redirect URL operations are exposed under ` clerkClient.redirectUrls ` . The following methods are available:
170
-
171
- ### Redirect URL ` get ` operations
172
-
173
- - [ ` getRedirectUrlList() ` ] ( /docs/references/backend/redirect-urls/get-redirect-url-list )
174
- - [ ` getRedirectUrl() ` ] ( /docs/references/backend/redirect-urls/get-redirect-url )
175
-
176
- ### Redirect URL ` create ` operations
177
-
178
- - [ ` createRedirectUrl() ` ] ( /docs/references/backend/redirect-urls/create-redirect-url )
179
-
180
- ### Redirect URL ` delete ` operations
181
-
182
- - [ ` deleteRedirectUrl() ` ] ( /docs/references/backend/redirect-urls/delete-redirect-url )
183
-
184
- ## Email address operations
185
-
186
- A user can be associated with one or more email addresses.
187
-
188
- Email address operations are exposed under ` clerkClient.emailAddresses ` . The following methods are available:
189
-
190
- ### Email address ` get ` operations
191
-
192
- - [ ` getEmailAddress() ` ] ( /docs/references/backend/email-addresses/get-email-address )
193
-
194
- ### Email address ` create ` operations
195
-
196
- - [ ` createEmailAddress() ` ] ( /docs/references/backend/email-addresses/create-email-address )
197
-
198
- ### Email address ` update ` operations
199
-
200
- - [ ` updateEmailAddress() ` ] ( /docs/references/backend/email-addresses/update-email-address )
201
-
202
- ### Email address ` delete ` operations
203
-
204
- - [ ` deleteEmailAddress() ` ] ( /docs/references/backend/email-addresses/delete-email-address )
205
-
206
- ## Phone number operations
207
-
208
- A user can be associated with one or more phone numbers.
209
-
210
- Phone number operations are exposed under ` clerkClient.phoneNumbers ` . The following methods are available:
211
-
212
- ### Phone number ` get ` operations
213
-
214
- - [ ` getPhoneNumber() ` ] ( /docs/references/backend/phone-numbers/get-phone-number )
215
-
216
- ### Phone number ` create ` operations
217
-
218
- - [ ` createPhoneNumber() ` ] ( /docs/references/backend/phone-numbers/create-phone-number )
219
-
220
- ### Phone number ` update ` operations
221
-
222
- - [ ` updatePhoneNumber() ` ] ( /docs/references/backend/phone-numbers/update-phone-number )
223
-
224
- ### Phone number ` delete ` operations
225
-
226
- - [ ` deletePhoneNumber() ` ] ( /docs/references/backend/phone-numbers/delete-phone-number )
227
-
228
- ## Testing tokens operations
229
-
230
- A testing token can be used to bypass the Bot Protection rules on E2E testing.
231
-
232
- Testing tokens operations are exposed under ` clerkClient.testingTokens ` with the [ ` createTestingToken() ` ] ( /docs/references/backend/testing-tokens/create-testing-token ) helper method.
233
-
234
-
235
-
236
- ## Email ` create ` operations (deprecated)
237
-
238
- <Callout type = " danger" >
239
- This operation is now deprecated. Clerk no longer supports sending emails through Clerk's backend API.
240
- </Callout >
241
-
242
- ## SMS message operations (deprecated)
243
-
244
- <Callout type = " danger" >
245
- This operation is now deprecated. Clerk no longer supports sending SMS messages through Clerk's backend API.
246
- </Callout >
0 commit comments