Skip to content

remove repetition of pages in nav from the backend sdk overview #957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
202 changes: 0 additions & 202 deletions docs/references/backend/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,205 +42,3 @@ Clerk SDKs expose an instance of the Clerk Backend SDK for use in server environ
```
</Tab>
</Tabs>

## User operations

User operations are exposed under `clerkClient.users`. The following methods are available:

### User `get` operations

- [`getUserList()`](/docs/references/backend/user/get-user-list)
- [`getUser()`](/docs/references/backend/user/get-user)
- [`getCount()`](/docs/references/backend/user/get-count)
- [`getOrganizationMembershipList()`](/docs/references/backend/user/get-organization-membership-list)
- [`getUserOauthAccessToken()`](/docs/references/backend/user/get-user-oauth-access-token)

### User `create` operations

- [`createUser()`](/docs/references/backend/user/create-user)
- [`verifyPassword()`](/docs/references/backend/user/verify-password)
- [`banUser()`](/docs/references/backend/user/ban-user)
- [`unbanUser()`](/docs/references/backend/user/unban-user)
- [`lockUser()`](/docs/references/backend/user/lock-user)
- [`unlockUser()`](/docs/references/backend/user/unlock-user)

### User `update` operations

- [`updateUser()`](/docs/references/backend/user/update-user)
- [`updateUserMetadata()`](/docs/references/backend/user/update-user-metadata)

### User `delete` operations

- [`deleteUser()`](/docs/references/backend/user/delete-user)
- [`disableUserMFA()`](/docs/references/backend/user/disable-user-mfa)

## Organization operations

Organization operations are exposed under `clerkClient.organizations`. The following methods are available:

### Organization `get` operations

- [`getOrganization()`](/docs/references/backend/organization/get-organization)
- [`getOrganizationList()`](/docs/references/backend/organization/get-organization-list)
- [`getOrganizationMembershipList()`](/docs/references/backend/organization/get-organization-membership-list)
- [`getOrganizationInvitationList()`](/docs/references/backend/organization/get-organization-invitation-list)

### Organization `create` operations

- [`createOrganization()`](/docs/references/backend/organization/create-organization)
- [`createOrganizationMembership()`](/docs/references/backend/organization/create-organization-membership)
- [`createOrganizationInvitation()`](/docs/references/backend/organization/create-organization-invitation)

### Organization `update` operations

- [`updateOrganization()`](/docs/references/backend/organization/update-organization)
- [`updateOrganizationMembership()`](/docs/references/backend/organization/update-organization-membership)
- [`updateOrganizationMetadata()`](/docs/references/backend/organization/update-organization-metadata)
- [`updateOrganizationMembershipMetadata()`](/docs/references/backend/organization/update-organization-membership-metadata)

### Organization `delete` operations

- [`deleteOrganization()`](/docs/references/backend/organization/delete-organization)
- [`deleteOrganizationMembership()`](/docs/references/backend/organization/delete-organization-membership)
- [`revokeOrganizationInvitation()`](/docs/references/backend/organization/revoke-organization-invitation)

## Allowlist Identifiers operations

Allowlist Identifiers operations are exposed under `clerkClient.allowlistIdentifiers`. The following methods are available:

### Allowlist Identifiers `get` operations

- [`getAllowlistIdentifierList()`](/docs/references/backend/allowlist/get-allowlist-identifier-list)

### Allowlist Identifiers `create` operations

- [`createAllowlistIdentifier()`](/docs/references/backend/allowlist/create-allowlist-identifier)

### Allowlist Identifiers `delete` operations

- [`deleteAllowlistIdentifier()`](/docs/references/backend/allowlist/delete-allowlist-identifier)

## Session operations

Session operations are exposed under `clerkClient.sessions`. The following methods are available:

### Session `get` operations

- [`getSession()`](/docs/references/backend/sessions/get-session)
- [`getSessionList()`](/docs/references/backend/sessions/get-session-list)
- [`getToken()`](/docs/references/backend/sessions/get-token)
- [`authenticateRequest()`](/docs/references/backend/sessions/authenticate-request)
- [`verifySession()` (deprecated)](/docs/references/backend/sessions/verify-session)

### Session `delete` operations

- [`revokeSession()`](/docs/references/backend/sessions/revoke-session)

## Client operations

Client operations are exposed under `clerkClient.clients`. The following methods are available:

### Client `get` operations

- [`getClient()`](/docs/references/backend/client/get-client)
- [`getClientList()` (deprecated)](/docs/references/backend/client/get-client-list)
- [`verifyClient()`](/docs/references/backend/client/verify-client)

## Invitation operations

Invitation operations are exposed under `clerkClient.invitations`. The following methods are available:

### Invitation `get` operations

- [`getInvitationList()`](/docs/references/backend/invitations/get-invitation-list)

### Invitation `create` operations

- [`createInvitation()`](/docs/references/backend/invitations/create-invitation)

### Invitation `delete` operations

- [`revokeInvitation()`](/docs/references/backend/invitations/revoke-invitation)

## Redirect URL operations

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.

Redirect URL operations are exposed under `clerkClient.redirectUrls`. The following methods are available:

### Redirect URL `get` operations

- [`getRedirectUrlList()`](/docs/references/backend/redirect-urls/get-redirect-url-list)
- [`getRedirectUrl()`](/docs/references/backend/redirect-urls/get-redirect-url)

### Redirect URL `create` operations

- [`createRedirectUrl()`](/docs/references/backend/redirect-urls/create-redirect-url)

### Redirect URL `delete` operations

- [`deleteRedirectUrl()`](/docs/references/backend/redirect-urls/delete-redirect-url)

## Email address operations

A user can be associated with one or more email addresses.

Email address operations are exposed under `clerkClient.emailAddresses`. The following methods are available:

### Email address `get` operations

- [`getEmailAddress()`](/docs/references/backend/email-addresses/get-email-address)

### Email address `create` operations

- [`createEmailAddress()`](/docs/references/backend/email-addresses/create-email-address)

### Email address `update` operations

- [`updateEmailAddress()`](/docs/references/backend/email-addresses/update-email-address)

### Email address `delete` operations

- [`deleteEmailAddress()`](/docs/references/backend/email-addresses/delete-email-address)

## Phone number operations

A user can be associated with one or more phone numbers.

Phone number operations are exposed under `clerkClient.phoneNumbers`. The following methods are available:

### Phone number `get` operations

- [`getPhoneNumber()`](/docs/references/backend/phone-numbers/get-phone-number)

### Phone number `create` operations

- [`createPhoneNumber()`](/docs/references/backend/phone-numbers/create-phone-number)

### Phone number `update` operations

- [`updatePhoneNumber()`](/docs/references/backend/phone-numbers/update-phone-number)

### Phone number `delete` operations

- [`deletePhoneNumber()`](/docs/references/backend/phone-numbers/delete-phone-number)

## Testing tokens operations

A testing token can be used to bypass the Bot Protection rules on E2E testing.

Testing tokens operations are exposed under `clerkClient.testingTokens` with the [`createTestingToken()`](/docs/references/backend/testing-tokens/create-testing-token) helper method.



## Email `create` operations (deprecated)

<Callout type="danger">
This operation is now deprecated. Clerk no longer supports sending emails through Clerk's backend API.
</Callout>

## SMS message operations (deprecated)

<Callout type="danger">
This operation is now deprecated. Clerk no longer supports sending SMS messages through Clerk's backend API.
</Callout>
Loading