Skip to content

feat(backend): Support recent BAPI users and email/phone features#8694

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.

Sign up for GitHub

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
brkalow merged 2 commits into from
May 29, 2026
Merged

feat(backend): Support recent BAPI users and email/phone features #8694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bdbdaa1
feat(backend): Support recent BAPI users and email/phone changes
dmoerner May 28, 2026
73c627e
chore: remove stale changeset
dmoerner May 29, 2026
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
9 changes: 9 additions & 0 deletions .changeset/backend-user-replace-email-phone-and-banned-locked.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/backend': minor
---

Add support for new Backend API user endpoints:

- `users.replaceUserEmailAddress(userId, { emailAddress })` replaces all of a user's email addresses with a single verified, primary email address (`PUT /users/{user_id}/email_address`).
- `users.replaceUserPhoneNumber(userId, { phoneNumber })` replaces all of a user's phone numbers with a single verified, primary phone number (`PUT /users/{user_id}/phone_number`).
- `users.createUser` now accepts `banned` and `locked` parameters to create a user that is already banned or locked.
36 changes: 36 additions & 0 deletions packages/backend/src/api/endpoints/UserApi.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,11 @@ import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type {
DeletedObject,
EmailAddress,
OauthAccessToken,
OrganizationInvitation,
OrganizationMembership,
PhoneNumber,
User,
} from '../resources';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
Expand DownExpand Up@@ -99,6 +101,10 @@ type CreateUserParams = {
totpSecret?: string;
backupCodes?: string[];
createdAt?: Date;
/** When set to `true`, the user is created already banned and cannot sign in. Requires the same plan support as the ban user endpoint. */
banned?: boolean;
/** When set to `true`, the user is created already locked. Requires the user lockout feature to be enabled on the instance. */
locked?: boolean;
} & UserMetadataParams &
(UserPasswordHashingParams | object);

Expand DownExpand Up@@ -212,6 +218,16 @@ type SetPasswordCompromisedParams = {
revokeAllSessions?: boolean;
};

type ReplaceUserEmailAddressParams = {
/** The new email address. Must adhere to the RFC 5322 specification for email address format. */
emailAddress: string;
};

type ReplaceUserPhoneNumberParams = {
/** The new phone number. Must adhere to the E.164 standard for phone number format. */
phoneNumber: string;
};

type UserID = {
userId: string;
};
Expand DownExpand Up@@ -259,6 +275,26 @@ export class UserAPI extends AbstractAPI {
});
}

public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {
this.requireId(userId);

return this.request<EmailAddress>({
method: 'PUT',
path: joinPaths(basePath, userId, 'email_address'),
bodyParams: params,
});
}

public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {
this.requireId(userId);

return this.request<PhoneNumber>({
method: 'PUT',
path: joinPaths(basePath, userId, 'phone_number'),
bodyParams: params,
});
}
Comment on lines +278 to +296

@coderabbitaicoderabbitaiBotMay 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash# Verify public async methods without explicit return types in UserApi.ts
rg -nP "public async [A-Za-z0-9_]+\([^)]*\)\s*\{" packages/backend/src/api/endpoints/UserApi.ts

Repository: clerk/javascript

Length of output: 1919

Add explicit Promise return types for new UserApi public methods

replaceUserEmailAddress and replaceUserPhoneNumber should declare : Promise<EmailAddress> / : Promise<PhoneNumber> for a stable public surface.

Proposed fix
- public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {+ public async replaceUserEmailAddress(+ userId: string,+ params: ReplaceUserEmailAddressParams,+ ): Promise<EmailAddress> {
this.requireId(userId);
return this.request<EmailAddress>({
method: 'PUT',
path: joinPaths(basePath, userId, 'email_address'),
bodyParams: params,
});
}
- public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {+ public async replaceUserPhoneNumber(+ userId: string,+ params: ReplaceUserPhoneNumberParams,+ ): Promise<PhoneNumber> {
this.requireId(userId);
return this.request<PhoneNumber>({
method: 'PUT',
path: joinPaths(basePath, userId, 'phone_number'),
bodyParams: params,
});
}

Add tests covering these newly introduced API methods/endpoints.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/backend/src/api/endpoints/UserApi.ts` around lines 278 - 296, Update
the public method signatures in UserApi so they explicitly declare Promise
return types: change replaceUserEmailAddress(userId: string, params:
ReplaceUserEmailAddressParams) to replaceUserEmailAddress(userId: string,
params: ReplaceUserEmailAddressParams): Promise<EmailAddress> and
replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams):
Promise<PhoneNumber>; keep the existing this.request calls but ensure the
declared return types match the generic types passed to this.request, and add
unit/integration tests that call UserApi.replaceUserEmailAddress and
UserApi.replaceUserPhoneNumber to verify request shape and response handling for
the new endpoints.


public async updateUserProfileImage(userId: string, params: { file: Blob | File }) {
this.requireId(userId);

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(backend): Support recent BAPI users and email/phone features by dmoerner · Pull Request #8694 · clerk/javascript · GitHub
Skip to content
feat(backend): Support recent BAPI users and email/phone features#8694

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.

 Sign up for GitHub

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

brkalow
merged 2 commits into

from

May 29, 2026
 Merged


feat(backend): Support recent BAPI users and email/phone features
#8694
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
bdbdaa1

feat(backend): Support recent BAPI users and email/phone changes


dmoerner May 28, 2026
73c627e

chore: remove stale changeset


dmoerner May 29, 2026

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


9 changes: 9 additions & 0 deletions
.changeset/backend-user-replace-email-phone-and-banned-locked.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/backend': minor
---

Add support for new Backend API user endpoints:

- `users.replaceUserEmailAddress(userId, { emailAddress })` replaces all of a user's email addresses with a single verified, primary email address (`PUT /users/{user_id}/email_address`).
- `users.replaceUserPhoneNumber(userId, { phoneNumber })` replaces all of a user's phone numbers with a single verified, primary phone number (`PUT /users/{user_id}/phone_number`).
- `users.createUser` now accepts `banned` and `locked` parameters to create a user that is already banned or locked.

36 changes: 36 additions & 0 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,11 @@ import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type {
 DeletedObject,
 EmailAddress,
 OauthAccessToken,
 OrganizationInvitation,
 OrganizationMembership,
 PhoneNumber,
 User,
} from '../resources';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
Expand DownExpand Up@@ -99,6 +101,10 @@ type CreateUserParams = {
 totpSecret?: string;
 backupCodes?: string[];
 createdAt?: Date;
 /** When set to `true`, the user is created already banned and cannot sign in. Requires the same plan support as the ban user endpoint. */
 banned?: boolean;
 /** When set to `true`, the user is created already locked. Requires the user lockout feature to be enabled on the instance. */
 locked?: boolean;
} & UserMetadataParams &
 (UserPasswordHashingParams | object);

Expand DownExpand Up@@ -212,6 +218,16 @@ type SetPasswordCompromisedParams = {
 revokeAllSessions?: boolean;
};

type ReplaceUserEmailAddressParams = {
 /** The new email address. Must adhere to the RFC 5322 specification for email address format. */
 emailAddress: string;
};

type ReplaceUserPhoneNumberParams = {
 /** The new phone number. Must adhere to the E.164 standard for phone number format. */
 phoneNumber: string;
};

type UserID = {
 userId: string;
};
Expand DownExpand Up@@ -259,6 +275,26 @@ export class UserAPI extends AbstractAPI {
 });
 }

 public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {
 this.requireId(userId);

 return this.request<EmailAddress>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'email_address'),
 bodyParams: params,
 });
 }

 public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {
 this.requireId(userId);

 return this.request<PhoneNumber>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'phone_number'),
 bodyParams: params,
 });
 }

Comment on lines

+278
 to 
+296

@coderabbitaicoderabbitaiBotMay 28, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash# Verify public async methods without explicit return types in UserApi.ts
rg -nP "public async [A-Za-z0-9_]+\([^)]*\)\s*\{" packages/backend/src/api/endpoints/UserApi.ts
Repository: clerk/javascript
Length of output: 1919
Add explicit Promise return types for new UserApi public methods
replaceUserEmailAddress and replaceUserPhoneNumber should declare : Promise<EmailAddress> / : Promise<PhoneNumber> for a stable public surface.
Proposed fix
- public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {+ public async replaceUserEmailAddress(+ userId: string,+ params: ReplaceUserEmailAddressParams,+ ): Promise<EmailAddress> {
this.requireId(userId);
return this.request<EmailAddress>({
method: 'PUT',
path: joinPaths(basePath, userId, 'email_address'),
bodyParams: params,
});
}
- public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {+ public async replaceUserPhoneNumber(+ userId: string,+ params: ReplaceUserPhoneNumberParams,+ ): Promise<PhoneNumber> {
this.requireId(userId);
return this.request<PhoneNumber>({
method: 'PUT',
path: joinPaths(basePath, userId, 'phone_number'),
bodyParams: params,
});
}
Add tests covering these newly introduced API methods/endpoints.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/backend/src/api/endpoints/UserApi.ts` around lines 278 - 296, Update
the public method signatures in UserApi so they explicitly declare Promise
return types: change replaceUserEmailAddress(userId: string, params:
ReplaceUserEmailAddressParams) to replaceUserEmailAddress(userId: string,
params: ReplaceUserEmailAddressParams): Promise<EmailAddress> and
replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams):
Promise<PhoneNumber>; keep the existing this.request calls but ensure the
declared return types match the generic types passed to this.request, and add
unit/integration tests that call UserApi.replaceUserEmailAddress and
UserApi.replaceUserPhoneNumber to verify request shape and response handling for
the new endpoints.


 public async updateUserProfileImage(userId: string, params: { file: Blob | File }) {
 this.requireId(userId);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(backend): Support recent BAPI users and email/phone features by dmoerner · Pull Request #8694 · clerk/javascript · GitHub
Skip to content
feat(backend): Support recent BAPI users and email/phone features#8694

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.

 Sign up for GitHub

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

brkalow
merged 2 commits into

from

May 29, 2026
 Merged


feat(backend): Support recent BAPI users and email/phone features
#8694
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
bdbdaa1

feat(backend): Support recent BAPI users and email/phone changes


dmoerner May 28, 2026
73c627e

chore: remove stale changeset


dmoerner May 29, 2026

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


9 changes: 9 additions & 0 deletions
.changeset/backend-user-replace-email-phone-and-banned-locked.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/backend': minor
---

Add support for new Backend API user endpoints:

- `users.replaceUserEmailAddress(userId, { emailAddress })` replaces all of a user's email addresses with a single verified, primary email address (`PUT /users/{user_id}/email_address`).
- `users.replaceUserPhoneNumber(userId, { phoneNumber })` replaces all of a user's phone numbers with a single verified, primary phone number (`PUT /users/{user_id}/phone_number`).
- `users.createUser` now accepts `banned` and `locked` parameters to create a user that is already banned or locked.

36 changes: 36 additions & 0 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,11 @@ import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type {
 DeletedObject,
 EmailAddress,
 OauthAccessToken,
 OrganizationInvitation,
 OrganizationMembership,
 PhoneNumber,
 User,
} from '../resources';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
Expand DownExpand Up@@ -99,6 +101,10 @@ type CreateUserParams = {
 totpSecret?: string;
 backupCodes?: string[];
 createdAt?: Date;
 /** When set to `true`, the user is created already banned and cannot sign in. Requires the same plan support as the ban user endpoint. */
 banned?: boolean;
 /** When set to `true`, the user is created already locked. Requires the user lockout feature to be enabled on the instance. */
 locked?: boolean;
} & UserMetadataParams &
 (UserPasswordHashingParams | object);

Expand DownExpand Up@@ -212,6 +218,16 @@ type SetPasswordCompromisedParams = {
 revokeAllSessions?: boolean;
};

type ReplaceUserEmailAddressParams = {
 /** The new email address. Must adhere to the RFC 5322 specification for email address format. */
 emailAddress: string;
};

type ReplaceUserPhoneNumberParams = {
 /** The new phone number. Must adhere to the E.164 standard for phone number format. */
 phoneNumber: string;
};

type UserID = {
 userId: string;
};
Expand DownExpand Up@@ -259,6 +275,26 @@ export class UserAPI extends AbstractAPI {
 });
 }

 public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {
 this.requireId(userId);

 return this.request<EmailAddress>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'email_address'),
 bodyParams: params,
 });
 }

 public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {
 this.requireId(userId);

 return this.request<PhoneNumber>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'phone_number'),
 bodyParams: params,
 });
 }

Comment on lines

+278
 to 
+296

@coderabbitaicoderabbitaiBotMay 28, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash# Verify public async methods without explicit return types in UserApi.ts
rg -nP "public async [A-Za-z0-9_]+\([^)]*\)\s*\{" packages/backend/src/api/endpoints/UserApi.ts
Repository: clerk/javascript
Length of output: 1919
Add explicit Promise return types for new UserApi public methods
replaceUserEmailAddress and replaceUserPhoneNumber should declare : Promise<EmailAddress> / : Promise<PhoneNumber> for a stable public surface.
Proposed fix
- public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {+ public async replaceUserEmailAddress(+ userId: string,+ params: ReplaceUserEmailAddressParams,+ ): Promise<EmailAddress> {
this.requireId(userId);
return this.request<EmailAddress>({
method: 'PUT',
path: joinPaths(basePath, userId, 'email_address'),
bodyParams: params,
});
}
- public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {+ public async replaceUserPhoneNumber(+ userId: string,+ params: ReplaceUserPhoneNumberParams,+ ): Promise<PhoneNumber> {
this.requireId(userId);
return this.request<PhoneNumber>({
method: 'PUT',
path: joinPaths(basePath, userId, 'phone_number'),
bodyParams: params,
});
}
Add tests covering these newly introduced API methods/endpoints.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/backend/src/api/endpoints/UserApi.ts` around lines 278 - 296, Update
the public method signatures in UserApi so they explicitly declare Promise
return types: change replaceUserEmailAddress(userId: string, params:
ReplaceUserEmailAddressParams) to replaceUserEmailAddress(userId: string,
params: ReplaceUserEmailAddressParams): Promise<EmailAddress> and
replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams):
Promise<PhoneNumber>; keep the existing this.request calls but ensure the
declared return types match the generic types passed to this.request, and add
unit/integration tests that call UserApi.replaceUserEmailAddress and
UserApi.replaceUserPhoneNumber to verify request shape and response handling for
the new endpoints.


 public async updateUserProfileImage(userId: string, params: { file: Blob | File }) {
 this.requireId(userId);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(backend): Support recent BAPI users and email/phone features by dmoerner · Pull Request #8694 · clerk/javascript · GitHub
Skip to content
feat(backend): Support recent BAPI users and email/phone features#8694

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.

 Sign up for GitHub

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

brkalow
merged 2 commits into

from

May 29, 2026
 Merged


feat(backend): Support recent BAPI users and email/phone features
#8694
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
bdbdaa1

feat(backend): Support recent BAPI users and email/phone changes


dmoerner May 28, 2026
73c627e

chore: remove stale changeset


dmoerner May 29, 2026

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


9 changes: 9 additions & 0 deletions
.changeset/backend-user-replace-email-phone-and-banned-locked.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/backend': minor
---

Add support for new Backend API user endpoints:

- `users.replaceUserEmailAddress(userId, { emailAddress })` replaces all of a user's email addresses with a single verified, primary email address (`PUT /users/{user_id}/email_address`).
- `users.replaceUserPhoneNumber(userId, { phoneNumber })` replaces all of a user's phone numbers with a single verified, primary phone number (`PUT /users/{user_id}/phone_number`).
- `users.createUser` now accepts `banned` and `locked` parameters to create a user that is already banned or locked.

36 changes: 36 additions & 0 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,11 @@ import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type {
 DeletedObject,
 EmailAddress,
 OauthAccessToken,
 OrganizationInvitation,
 OrganizationMembership,
 PhoneNumber,
 User,
} from '../resources';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
Expand DownExpand Up@@ -99,6 +101,10 @@ type CreateUserParams = {
 totpSecret?: string;
 backupCodes?: string[];
 createdAt?: Date;
 /** When set to `true`, the user is created already banned and cannot sign in. Requires the same plan support as the ban user endpoint. */
 banned?: boolean;
 /** When set to `true`, the user is created already locked. Requires the user lockout feature to be enabled on the instance. */
 locked?: boolean;
} & UserMetadataParams &
 (UserPasswordHashingParams | object);

Expand DownExpand Up@@ -212,6 +218,16 @@ type SetPasswordCompromisedParams = {
 revokeAllSessions?: boolean;
};

type ReplaceUserEmailAddressParams = {
 /** The new email address. Must adhere to the RFC 5322 specification for email address format. */
 emailAddress: string;
};

type ReplaceUserPhoneNumberParams = {
 /** The new phone number. Must adhere to the E.164 standard for phone number format. */
 phoneNumber: string;
};

type UserID = {
 userId: string;
};
Expand DownExpand Up@@ -259,6 +275,26 @@ export class UserAPI extends AbstractAPI {
 });
 }

 public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {
 this.requireId(userId);

 return this.request<EmailAddress>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'email_address'),
 bodyParams: params,
 });
 }

 public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {
 this.requireId(userId);

 return this.request<PhoneNumber>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'phone_number'),
 bodyParams: params,
 });
 }

Comment on lines

+278
 to 
+296

@coderabbitaicoderabbitaiBotMay 28, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash# Verify public async methods without explicit return types in UserApi.ts
rg -nP "public async [A-Za-z0-9_]+\([^)]*\)\s*\{" packages/backend/src/api/endpoints/UserApi.ts
Repository: clerk/javascript
Length of output: 1919
Add explicit Promise return types for new UserApi public methods
replaceUserEmailAddress and replaceUserPhoneNumber should declare : Promise<EmailAddress> / : Promise<PhoneNumber> for a stable public surface.
Proposed fix
- public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {+ public async replaceUserEmailAddress(+ userId: string,+ params: ReplaceUserEmailAddressParams,+ ): Promise<EmailAddress> {
this.requireId(userId);
return this.request<EmailAddress>({
method: 'PUT',
path: joinPaths(basePath, userId, 'email_address'),
bodyParams: params,
});
}
- public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {+ public async replaceUserPhoneNumber(+ userId: string,+ params: ReplaceUserPhoneNumberParams,+ ): Promise<PhoneNumber> {
this.requireId(userId);
return this.request<PhoneNumber>({
method: 'PUT',
path: joinPaths(basePath, userId, 'phone_number'),
bodyParams: params,
});
}
Add tests covering these newly introduced API methods/endpoints.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/backend/src/api/endpoints/UserApi.ts` around lines 278 - 296, Update
the public method signatures in UserApi so they explicitly declare Promise
return types: change replaceUserEmailAddress(userId: string, params:
ReplaceUserEmailAddressParams) to replaceUserEmailAddress(userId: string,
params: ReplaceUserEmailAddressParams): Promise<EmailAddress> and
replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams):
Promise<PhoneNumber>; keep the existing this.request calls but ensure the
declared return types match the generic types passed to this.request, and add
unit/integration tests that call UserApi.replaceUserEmailAddress and
UserApi.replaceUserPhoneNumber to verify request shape and response handling for
the new endpoints.


 public async updateUserProfileImage(userId: string, params: { file: Blob | File }) {
 this.requireId(userId);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(backend): Support recent BAPI users and email/phone features by dmoerner · Pull Request #8694 · clerk/javascript · GitHub
Skip to content
feat(backend): Support recent BAPI users and email/phone features#8694

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.

 Sign up for GitHub

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

brkalow
merged 2 commits into

from

May 29, 2026
 Merged


feat(backend): Support recent BAPI users and email/phone features
#8694
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
bdbdaa1

feat(backend): Support recent BAPI users and email/phone changes


dmoerner May 28, 2026
73c627e

chore: remove stale changeset


dmoerner May 29, 2026

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


9 changes: 9 additions & 0 deletions
.changeset/backend-user-replace-email-phone-and-banned-locked.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/backend': minor
---

Add support for new Backend API user endpoints:

- `users.replaceUserEmailAddress(userId, { emailAddress })` replaces all of a user's email addresses with a single verified, primary email address (`PUT /users/{user_id}/email_address`).
- `users.replaceUserPhoneNumber(userId, { phoneNumber })` replaces all of a user's phone numbers with a single verified, primary phone number (`PUT /users/{user_id}/phone_number`).
- `users.createUser` now accepts `banned` and `locked` parameters to create a user that is already banned or locked.

36 changes: 36 additions & 0 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,11 @@ import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type {
 DeletedObject,
 EmailAddress,
 OauthAccessToken,
 OrganizationInvitation,
 OrganizationMembership,
 PhoneNumber,
 User,
} from '../resources';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
Expand DownExpand Up@@ -99,6 +101,10 @@ type CreateUserParams = {
 totpSecret?: string;
 backupCodes?: string[];
 createdAt?: Date;
 /** When set to `true`, the user is created already banned and cannot sign in. Requires the same plan support as the ban user endpoint. */
 banned?: boolean;
 /** When set to `true`, the user is created already locked. Requires the user lockout feature to be enabled on the instance. */
 locked?: boolean;
} & UserMetadataParams &
 (UserPasswordHashingParams | object);

Expand DownExpand Up@@ -212,6 +218,16 @@ type SetPasswordCompromisedParams = {
 revokeAllSessions?: boolean;
};

type ReplaceUserEmailAddressParams = {
 /** The new email address. Must adhere to the RFC 5322 specification for email address format. */
 emailAddress: string;
};

type ReplaceUserPhoneNumberParams = {
 /** The new phone number. Must adhere to the E.164 standard for phone number format. */
 phoneNumber: string;
};

type UserID = {
 userId: string;
};
Expand DownExpand Up@@ -259,6 +275,26 @@ export class UserAPI extends AbstractAPI {
 });
 }

 public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {
 this.requireId(userId);

 return this.request<EmailAddress>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'email_address'),
 bodyParams: params,
 });
 }

 public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {
 this.requireId(userId);

 return this.request<PhoneNumber>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'phone_number'),
 bodyParams: params,
 });
 }

Comment on lines

+278
 to 
+296

@coderabbitaicoderabbitaiBotMay 28, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash# Verify public async methods without explicit return types in UserApi.ts
rg -nP "public async [A-Za-z0-9_]+\([^)]*\)\s*\{" packages/backend/src/api/endpoints/UserApi.ts
Repository: clerk/javascript
Length of output: 1919
Add explicit Promise return types for new UserApi public methods
replaceUserEmailAddress and replaceUserPhoneNumber should declare : Promise<EmailAddress> / : Promise<PhoneNumber> for a stable public surface.
Proposed fix
- public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {+ public async replaceUserEmailAddress(+ userId: string,+ params: ReplaceUserEmailAddressParams,+ ): Promise<EmailAddress> {
this.requireId(userId);
return this.request<EmailAddress>({
method: 'PUT',
path: joinPaths(basePath, userId, 'email_address'),
bodyParams: params,
});
}
- public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {+ public async replaceUserPhoneNumber(+ userId: string,+ params: ReplaceUserPhoneNumberParams,+ ): Promise<PhoneNumber> {
this.requireId(userId);
return this.request<PhoneNumber>({
method: 'PUT',
path: joinPaths(basePath, userId, 'phone_number'),
bodyParams: params,
});
}
Add tests covering these newly introduced API methods/endpoints.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/backend/src/api/endpoints/UserApi.ts` around lines 278 - 296, Update
the public method signatures in UserApi so they explicitly declare Promise
return types: change replaceUserEmailAddress(userId: string, params:
ReplaceUserEmailAddressParams) to replaceUserEmailAddress(userId: string,
params: ReplaceUserEmailAddressParams): Promise<EmailAddress> and
replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams):
Promise<PhoneNumber>; keep the existing this.request calls but ensure the
declared return types match the generic types passed to this.request, and add
unit/integration tests that call UserApi.replaceUserEmailAddress and
UserApi.replaceUserPhoneNumber to verify request shape and response handling for
the new endpoints.


 public async updateUserProfileImage(userId: string, params: { file: Blob | File }) {
 this.requireId(userId);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(backend): Support recent BAPI users and email/phone features by dmoerner · Pull Request #8694 · clerk/javascript · GitHub
Skip to content
feat(backend): Support recent BAPI users and email/phone features#8694

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.

 Sign up for GitHub

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

brkalow
merged 2 commits into

from

May 29, 2026
 Merged


feat(backend): Support recent BAPI users and email/phone features
#8694
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
bdbdaa1

feat(backend): Support recent BAPI users and email/phone changes


dmoerner May 28, 2026
73c627e

chore: remove stale changeset


dmoerner May 29, 2026

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


9 changes: 9 additions & 0 deletions
.changeset/backend-user-replace-email-phone-and-banned-locked.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/backend': minor
---

Add support for new Backend API user endpoints:

- `users.replaceUserEmailAddress(userId, { emailAddress })` replaces all of a user's email addresses with a single verified, primary email address (`PUT /users/{user_id}/email_address`).
- `users.replaceUserPhoneNumber(userId, { phoneNumber })` replaces all of a user's phone numbers with a single verified, primary phone number (`PUT /users/{user_id}/phone_number`).
- `users.createUser` now accepts `banned` and `locked` parameters to create a user that is already banned or locked.

36 changes: 36 additions & 0 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,11 @@ import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type {
 DeletedObject,
 EmailAddress,
 OauthAccessToken,
 OrganizationInvitation,
 OrganizationMembership,
 PhoneNumber,
 User,
} from '../resources';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
Expand DownExpand Up@@ -99,6 +101,10 @@ type CreateUserParams = {
 totpSecret?: string;
 backupCodes?: string[];
 createdAt?: Date;
 /** When set to `true`, the user is created already banned and cannot sign in. Requires the same plan support as the ban user endpoint. */
 banned?: boolean;
 /** When set to `true`, the user is created already locked. Requires the user lockout feature to be enabled on the instance. */
 locked?: boolean;
} & UserMetadataParams &
 (UserPasswordHashingParams | object);

Expand DownExpand Up@@ -212,6 +218,16 @@ type SetPasswordCompromisedParams = {
 revokeAllSessions?: boolean;
};

type ReplaceUserEmailAddressParams = {
 /** The new email address. Must adhere to the RFC 5322 specification for email address format. */
 emailAddress: string;
};

type ReplaceUserPhoneNumberParams = {
 /** The new phone number. Must adhere to the E.164 standard for phone number format. */
 phoneNumber: string;
};

type UserID = {
 userId: string;
};
Expand DownExpand Up@@ -259,6 +275,26 @@ export class UserAPI extends AbstractAPI {
 });
 }

 public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {
 this.requireId(userId);

 return this.request<EmailAddress>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'email_address'),
 bodyParams: params,
 });
 }

 public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {
 this.requireId(userId);

 return this.request<PhoneNumber>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'phone_number'),
 bodyParams: params,
 });
 }

Comment on lines

+278
 to 
+296

@coderabbitaicoderabbitaiBotMay 28, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash# Verify public async methods without explicit return types in UserApi.ts
rg -nP "public async [A-Za-z0-9_]+\([^)]*\)\s*\{" packages/backend/src/api/endpoints/UserApi.ts
Repository: clerk/javascript
Length of output: 1919
Add explicit Promise return types for new UserApi public methods
replaceUserEmailAddress and replaceUserPhoneNumber should declare : Promise<EmailAddress> / : Promise<PhoneNumber> for a stable public surface.
Proposed fix
- public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {+ public async replaceUserEmailAddress(+ userId: string,+ params: ReplaceUserEmailAddressParams,+ ): Promise<EmailAddress> {
this.requireId(userId);
return this.request<EmailAddress>({
method: 'PUT',
path: joinPaths(basePath, userId, 'email_address'),
bodyParams: params,
});
}
- public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {+ public async replaceUserPhoneNumber(+ userId: string,+ params: ReplaceUserPhoneNumberParams,+ ): Promise<PhoneNumber> {
this.requireId(userId);
return this.request<PhoneNumber>({
method: 'PUT',
path: joinPaths(basePath, userId, 'phone_number'),
bodyParams: params,
});
}
Add tests covering these newly introduced API methods/endpoints.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/backend/src/api/endpoints/UserApi.ts` around lines 278 - 296, Update
the public method signatures in UserApi so they explicitly declare Promise
return types: change replaceUserEmailAddress(userId: string, params:
ReplaceUserEmailAddressParams) to replaceUserEmailAddress(userId: string,
params: ReplaceUserEmailAddressParams): Promise<EmailAddress> and
replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams):
Promise<PhoneNumber>; keep the existing this.request calls but ensure the
declared return types match the generic types passed to this.request, and add
unit/integration tests that call UserApi.replaceUserEmailAddress and
UserApi.replaceUserPhoneNumber to verify request shape and response handling for
the new endpoints.


 public async updateUserProfileImage(userId: string, params: { file: Blob | File }) {
 this.requireId(userId);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(backend): Support recent BAPI users and email/phone features by dmoerner · Pull Request #8694 · clerk/javascript · GitHub
Skip to content
feat(backend): Support recent BAPI users and email/phone features#8694

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.

 Sign up for GitHub

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

brkalow
merged 2 commits into

from

May 29, 2026
 Merged


feat(backend): Support recent BAPI users and email/phone features
#8694
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
bdbdaa1

feat(backend): Support recent BAPI users and email/phone changes


dmoerner May 28, 2026
73c627e

chore: remove stale changeset


dmoerner May 29, 2026

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


9 changes: 9 additions & 0 deletions
.changeset/backend-user-replace-email-phone-and-banned-locked.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/backend': minor
---

Add support for new Backend API user endpoints:

- `users.replaceUserEmailAddress(userId, { emailAddress })` replaces all of a user's email addresses with a single verified, primary email address (`PUT /users/{user_id}/email_address`).
- `users.replaceUserPhoneNumber(userId, { phoneNumber })` replaces all of a user's phone numbers with a single verified, primary phone number (`PUT /users/{user_id}/phone_number`).
- `users.createUser` now accepts `banned` and `locked` parameters to create a user that is already banned or locked.

36 changes: 36 additions & 0 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,11 @@ import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type {
 DeletedObject,
 EmailAddress,
 OauthAccessToken,
 OrganizationInvitation,
 OrganizationMembership,
 PhoneNumber,
 User,
} from '../resources';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
Expand DownExpand Up@@ -99,6 +101,10 @@ type CreateUserParams = {
 totpSecret?: string;
 backupCodes?: string[];
 createdAt?: Date;
 /** When set to `true`, the user is created already banned and cannot sign in. Requires the same plan support as the ban user endpoint. */
 banned?: boolean;
 /** When set to `true`, the user is created already locked. Requires the user lockout feature to be enabled on the instance. */
 locked?: boolean;
} & UserMetadataParams &
 (UserPasswordHashingParams | object);

Expand DownExpand Up@@ -212,6 +218,16 @@ type SetPasswordCompromisedParams = {
 revokeAllSessions?: boolean;
};

type ReplaceUserEmailAddressParams = {
 /** The new email address. Must adhere to the RFC 5322 specification for email address format. */
 emailAddress: string;
};

type ReplaceUserPhoneNumberParams = {
 /** The new phone number. Must adhere to the E.164 standard for phone number format. */
 phoneNumber: string;
};

type UserID = {
 userId: string;
};
Expand DownExpand Up@@ -259,6 +275,26 @@ export class UserAPI extends AbstractAPI {
 });
 }

 public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {
 this.requireId(userId);

 return this.request<EmailAddress>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'email_address'),
 bodyParams: params,
 });
 }

 public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {
 this.requireId(userId);

 return this.request<PhoneNumber>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'phone_number'),
 bodyParams: params,
 });
 }

Comment on lines

+278
 to 
+296

@coderabbitaicoderabbitaiBotMay 28, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash# Verify public async methods without explicit return types in UserApi.ts
rg -nP "public async [A-Za-z0-9_]+\([^)]*\)\s*\{" packages/backend/src/api/endpoints/UserApi.ts
Repository: clerk/javascript
Length of output: 1919
Add explicit Promise return types for new UserApi public methods
replaceUserEmailAddress and replaceUserPhoneNumber should declare : Promise<EmailAddress> / : Promise<PhoneNumber> for a stable public surface.
Proposed fix
- public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {+ public async replaceUserEmailAddress(+ userId: string,+ params: ReplaceUserEmailAddressParams,+ ): Promise<EmailAddress> {
this.requireId(userId);
return this.request<EmailAddress>({
method: 'PUT',
path: joinPaths(basePath, userId, 'email_address'),
bodyParams: params,
});
}
- public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {+ public async replaceUserPhoneNumber(+ userId: string,+ params: ReplaceUserPhoneNumberParams,+ ): Promise<PhoneNumber> {
this.requireId(userId);
return this.request<PhoneNumber>({
method: 'PUT',
path: joinPaths(basePath, userId, 'phone_number'),
bodyParams: params,
});
}
Add tests covering these newly introduced API methods/endpoints.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/backend/src/api/endpoints/UserApi.ts` around lines 278 - 296, Update
the public method signatures in UserApi so they explicitly declare Promise
return types: change replaceUserEmailAddress(userId: string, params:
ReplaceUserEmailAddressParams) to replaceUserEmailAddress(userId: string,
params: ReplaceUserEmailAddressParams): Promise<EmailAddress> and
replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams):
Promise<PhoneNumber>; keep the existing this.request calls but ensure the
declared return types match the generic types passed to this.request, and add
unit/integration tests that call UserApi.replaceUserEmailAddress and
UserApi.replaceUserPhoneNumber to verify request shape and response handling for
the new endpoints.


 public async updateUserProfileImage(userId: string, params: { file: Blob | File }) {
 this.requireId(userId);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(backend): Support recent BAPI users and email/phone features by dmoerner · Pull Request #8694 · clerk/javascript · GitHub
Skip to content
feat(backend): Support recent BAPI users and email/phone features#8694

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.

 Sign up for GitHub

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

brkalow
merged 2 commits into

from

May 29, 2026
 Merged


feat(backend): Support recent BAPI users and email/phone features
#8694
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
bdbdaa1

feat(backend): Support recent BAPI users and email/phone changes


dmoerner May 28, 2026
73c627e

chore: remove stale changeset


dmoerner May 29, 2026

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


9 changes: 9 additions & 0 deletions
.changeset/backend-user-replace-email-phone-and-banned-locked.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/backend': minor
---

Add support for new Backend API user endpoints:

- `users.replaceUserEmailAddress(userId, { emailAddress })` replaces all of a user's email addresses with a single verified, primary email address (`PUT /users/{user_id}/email_address`).
- `users.replaceUserPhoneNumber(userId, { phoneNumber })` replaces all of a user's phone numbers with a single verified, primary phone number (`PUT /users/{user_id}/phone_number`).
- `users.createUser` now accepts `banned` and `locked` parameters to create a user that is already banned or locked.

36 changes: 36 additions & 0 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,11 @@ import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type {
 DeletedObject,
 EmailAddress,
 OauthAccessToken,
 OrganizationInvitation,
 OrganizationMembership,
 PhoneNumber,
 User,
} from '../resources';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
Expand DownExpand Up@@ -99,6 +101,10 @@ type CreateUserParams = {
 totpSecret?: string;
 backupCodes?: string[];
 createdAt?: Date;
 /** When set to `true`, the user is created already banned and cannot sign in. Requires the same plan support as the ban user endpoint. */
 banned?: boolean;
 /** When set to `true`, the user is created already locked. Requires the user lockout feature to be enabled on the instance. */
 locked?: boolean;
} & UserMetadataParams &
 (UserPasswordHashingParams | object);

Expand DownExpand Up@@ -212,6 +218,16 @@ type SetPasswordCompromisedParams = {
 revokeAllSessions?: boolean;
};

type ReplaceUserEmailAddressParams = {
 /** The new email address. Must adhere to the RFC 5322 specification for email address format. */
 emailAddress: string;
};

type ReplaceUserPhoneNumberParams = {
 /** The new phone number. Must adhere to the E.164 standard for phone number format. */
 phoneNumber: string;
};

type UserID = {
 userId: string;
};
Expand DownExpand Up@@ -259,6 +275,26 @@ export class UserAPI extends AbstractAPI {
 });
 }

 public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {
 this.requireId(userId);

 return this.request<EmailAddress>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'email_address'),
 bodyParams: params,
 });
 }

 public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {
 this.requireId(userId);

 return this.request<PhoneNumber>({
 method: 'PUT',
 path: joinPaths(basePath, userId, 'phone_number'),
 bodyParams: params,
 });
 }

Comment on lines

+278
 to 
+296

@coderabbitaicoderabbitaiBotMay 28, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash# Verify public async methods without explicit return types in UserApi.ts
rg -nP "public async [A-Za-z0-9_]+\([^)]*\)\s*\{" packages/backend/src/api/endpoints/UserApi.ts
Repository: clerk/javascript
Length of output: 1919
Add explicit Promise return types for new UserApi public methods
replaceUserEmailAddress and replaceUserPhoneNumber should declare : Promise<EmailAddress> / : Promise<PhoneNumber> for a stable public surface.
Proposed fix
- public async replaceUserEmailAddress(userId: string, params: ReplaceUserEmailAddressParams) {+ public async replaceUserEmailAddress(+ userId: string,+ params: ReplaceUserEmailAddressParams,+ ): Promise<EmailAddress> {
this.requireId(userId);
return this.request<EmailAddress>({
method: 'PUT',
path: joinPaths(basePath, userId, 'email_address'),
bodyParams: params,
});
}
- public async replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams) {+ public async replaceUserPhoneNumber(+ userId: string,+ params: ReplaceUserPhoneNumberParams,+ ): Promise<PhoneNumber> {
this.requireId(userId);
return this.request<PhoneNumber>({
method: 'PUT',
path: joinPaths(basePath, userId, 'phone_number'),
bodyParams: params,
});
}
Add tests covering these newly introduced API methods/endpoints.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/backend/src/api/endpoints/UserApi.ts` around lines 278 - 296, Update
the public method signatures in UserApi so they explicitly declare Promise
return types: change replaceUserEmailAddress(userId: string, params:
ReplaceUserEmailAddressParams) to replaceUserEmailAddress(userId: string,
params: ReplaceUserEmailAddressParams): Promise<EmailAddress> and
replaceUserPhoneNumber(userId: string, params: ReplaceUserPhoneNumberParams):
Promise<PhoneNumber>; keep the existing this.request calls but ensure the
declared return types match the generic types passed to this.request, and add
unit/integration tests that call UserApi.replaceUserEmailAddress and
UserApi.replaceUserPhoneNumber to verify request shape and response handling for
the new endpoints.


 public async updateUserProfileImage(userId: string, params: { file: Blob | File }) {
 this.requireId(userId);

Expand Down
Loading