Merged
Show file tree
Hide file tree
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
29 changes: 29 additions & 0 deletions .changeset/shiny-apples-travel.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
---
"@clerk/backend": minor
---

Add `list()` method to M2M tokens API to retrieve a list of machine-to-machine tokens for a given machine.

```ts
// Retrieve M2M tokens for a specific machine
const response = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
});

console.log(response.data); // M2MToken[]
console.log(response.totalCount); // number
```

Filter by revoked or expired tokens:

```ts
const revokedTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
revoked: true,
});

const expiredTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
expired: true,
});
```
205 changes: 194 additions & 11 deletions packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,14 @@ import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('M2MToken', () => {
const m2mId = 'mt_xxxxx';
const m2mSecret = 'mt_secret_xxxxx';
const m2mId = 'mt_1xxxxxxxxxxxxx';
const m2mSecret = 'mt_secret_1xxxxxxxxxxxxx';

const mockM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
token: m2mSecret,
revoked: false,
Expand DownExpand Up@@ -46,7 +46,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -72,7 +72,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -116,8 +116,8 @@ describe('M2MToken', () => {
const mockRevokedM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
revoked: true,
revocation_reason: 'revoked by test',
Expand DownExpand Up@@ -151,7 +151,7 @@ describe('M2MToken', () => {
expect(response.revoked).toBe(true);
expect(response.token).toBeUndefined();
expect(response.revocationReason).toBe('revoked by test');
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -229,7 +229,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -255,7 +255,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -282,4 +282,187 @@ describe('M2MToken', () => {
expect(errResponse.status).toBe(401);
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
m2m_tokens: [
{
...mockM2MToken,
id: 'mt_1xxxxxxxxxxxxx',
},
{
...mockM2MToken,
id: 'mt_2xxxxxxxxxxxxx',
revoked: true,
},
],
total_count: 2,
};

it('lists m2m tokens with machine secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const url = new URL(request.url);
expect(url.searchParams.get('subject')).toBe(machineId);
expect(url.searchParams.get('limit')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 10,
});

expect(response.data).toHaveLength(2);
expect(response.data[0].id).toBe('mt_1xxxxxxxxxxxxx');
expect(response.data[1].id).toBe('mt_2xxxxxxxxxxxxx');
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with instance secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer sk_xxxxx');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with revoked filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('revoked')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
revoked: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with expired filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('expired')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
expired: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with pagination', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('limit')).toBe('5');
expect(url.searchParams.get('offset')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 5,
offset: 10,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('requires a machine secret or instance secret to list m2m tokens', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(() => {
return HttpResponse.json(
{
errors: [
{
message: 'Unauthorized',
code: 'unauthorized',
},
],
},
{ status: 401 },
);
}),
),
);

const errResponse = await apiClient.m2m
.list({
subject: machineId,
})
.catch(err => err);

expect(errResponse.status).toBe(401);
});
});
});
30 changes: 30 additions & 0 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
*/
subject: string;
/**
* Whether to include revoked machine-to-machine tokens.
*
* @default false
*/
revoked?: boolean;
/**
* Whether to include expired machine-to-machine tokens.
*
* @default false
*/
expired?: boolean;
}>;

type CreateM2MTokenParams = {
/**
* Custom machine secret key for authentication.
Expand DownExpand Up@@ -58,6 +80,14 @@ export class M2MTokenApi extends AbstractAPI {
return options;
}

async list(queryParams: GetM2MTokenListParams) {
return this.request<PaginatedResourceResponse<M2MToken[]>>({
method: 'GET',
path: basePath,
queryParams,
});
}
Comment thread
wobsoriano marked this conversation as resolved.

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};

Expand Down
27 changes: 27 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,12 @@ export function deserialize<U = any>(payload: unknown): PaginatedResourceRespons
if (Array.isArray(payload)) {
const data = payload.map(item => jsonToObject(item)) as U;
return { data };
} else if (isM2MTokenResponse(payload)) {
// Handle M2M token list responses with m2m_tokens property
data = payload.m2m_tokens.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;

return { data, totalCount };
Comment thread
wobsoriano marked this conversation as resolved.
} else if (isPaginated(payload)) {
data = payload.data.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;
Expand All@@ -95,6 +101,27 @@ function isPaginated(payload: unknown): payload is PaginatedResponseJSON {
return Array.isArray(payload.data) && payload.data !== undefined;
}

/**
* Detects M2M token list responses from the Backend API.
*
* The Clerk Backend API returns M2M token lists with `m2m_tokens` and `total_count` properties.
* This function identifies those responses and normalizes them to the standard `data` and
* `totalCount` format for consistency with other paginated API methods across the SDK.
*
* This approach avoids making breaking changes to BAPI Proxy or supporting both response
* formats. Once BAPI Proxy is updated to return the standard `data` property format,
* this function can be safely removed.
*
* @see https://clerk.com/docs/reference/backend-api/tag/m2m-tokens/get/m2m_tokens
*/
function isM2MTokenResponse(payload: unknown): payload is { m2m_tokens: unknown[]; total_count: number } {
if (!payload || typeof payload !== 'object' || !('m2m_tokens' in payload)) {
return false;
}

return Array.isArray(payload.m2m_tokens);
}

function getCount(item: PaginatedResponseJSON) {
return item.total_count;
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
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
29 changes: 29 additions & 0 deletions .changeset/shiny-apples-travel.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
---
"@clerk/backend": minor
---

Add `list()` method to M2M tokens API to retrieve a list of machine-to-machine tokens for a given machine.

```ts
// Retrieve M2M tokens for a specific machine
const response = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
});

console.log(response.data); // M2MToken[]
console.log(response.totalCount); // number
```

Filter by revoked or expired tokens:

```ts
const revokedTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
revoked: true,
});

const expiredTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
expired: true,
});
```
205 changes: 194 additions & 11 deletions packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,14 @@ import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('M2MToken', () => {
const m2mId = 'mt_xxxxx';
const m2mSecret = 'mt_secret_xxxxx';
const m2mId = 'mt_1xxxxxxxxxxxxx';
const m2mSecret = 'mt_secret_1xxxxxxxxxxxxx';

const mockM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
token: m2mSecret,
revoked: false,
Expand DownExpand Up@@ -46,7 +46,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -72,7 +72,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -116,8 +116,8 @@ describe('M2MToken', () => {
const mockRevokedM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
revoked: true,
revocation_reason: 'revoked by test',
Expand DownExpand Up@@ -151,7 +151,7 @@ describe('M2MToken', () => {
expect(response.revoked).toBe(true);
expect(response.token).toBeUndefined();
expect(response.revocationReason).toBe('revoked by test');
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -229,7 +229,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -255,7 +255,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -282,4 +282,187 @@ describe('M2MToken', () => {
expect(errResponse.status).toBe(401);
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
m2m_tokens: [
{
...mockM2MToken,
id: 'mt_1xxxxxxxxxxxxx',
},
{
...mockM2MToken,
id: 'mt_2xxxxxxxxxxxxx',
revoked: true,
},
],
total_count: 2,
};

it('lists m2m tokens with machine secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const url = new URL(request.url);
expect(url.searchParams.get('subject')).toBe(machineId);
expect(url.searchParams.get('limit')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 10,
});

expect(response.data).toHaveLength(2);
expect(response.data[0].id).toBe('mt_1xxxxxxxxxxxxx');
expect(response.data[1].id).toBe('mt_2xxxxxxxxxxxxx');
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with instance secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer sk_xxxxx');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with revoked filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('revoked')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
revoked: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with expired filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('expired')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
expired: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with pagination', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('limit')).toBe('5');
expect(url.searchParams.get('offset')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 5,
offset: 10,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('requires a machine secret or instance secret to list m2m tokens', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(() => {
return HttpResponse.json(
{
errors: [
{
message: 'Unauthorized',
code: 'unauthorized',
},
],
},
{ status: 401 },
);
}),
),
);

const errResponse = await apiClient.m2m
.list({
subject: machineId,
})
.catch(err => err);

expect(errResponse.status).toBe(401);
});
});
});
30 changes: 30 additions & 0 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
*/
subject: string;
/**
* Whether to include revoked machine-to-machine tokens.
*
* @default false
*/
revoked?: boolean;
/**
* Whether to include expired machine-to-machine tokens.
*
* @default false
*/
expired?: boolean;
}>;

type CreateM2MTokenParams = {
/**
* Custom machine secret key for authentication.
Expand DownExpand Up@@ -58,6 +80,14 @@ export class M2MTokenApi extends AbstractAPI {
return options;
}

async list(queryParams: GetM2MTokenListParams) {
return this.request<PaginatedResourceResponse<M2MToken[]>>({
method: 'GET',
path: basePath,
queryParams,
});
}
Comment thread
wobsoriano marked this conversation as resolved.

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};

Expand Down
27 changes: 27 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,12 @@ export function deserialize<U = any>(payload: unknown): PaginatedResourceRespons
if (Array.isArray(payload)) {
const data = payload.map(item => jsonToObject(item)) as U;
return { data };
} else if (isM2MTokenResponse(payload)) {
// Handle M2M token list responses with m2m_tokens property
data = payload.m2m_tokens.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;

return { data, totalCount };
Comment thread
wobsoriano marked this conversation as resolved.
} else if (isPaginated(payload)) {
data = payload.data.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;
Expand All@@ -95,6 +101,27 @@ function isPaginated(payload: unknown): payload is PaginatedResponseJSON {
return Array.isArray(payload.data) && payload.data !== undefined;
}

/**
* Detects M2M token list responses from the Backend API.
*
* The Clerk Backend API returns M2M token lists with `m2m_tokens` and `total_count` properties.
* This function identifies those responses and normalizes them to the standard `data` and
* `totalCount` format for consistency with other paginated API methods across the SDK.
*
* This approach avoids making breaking changes to BAPI Proxy or supporting both response
* formats. Once BAPI Proxy is updated to return the standard `data` property format,
* this function can be safely removed.
*
* @see https://clerk.com/docs/reference/backend-api/tag/m2m-tokens/get/m2m_tokens
*/
function isM2MTokenResponse(payload: unknown): payload is { m2m_tokens: unknown[]; total_count: number } {
if (!payload || typeof payload !== 'object' || !('m2m_tokens' in payload)) {
return false;
}

return Array.isArray(payload.m2m_tokens);
}

function getCount(item: PaginatedResponseJSON) {
return item.total_count;
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
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
29 changes: 29 additions & 0 deletions .changeset/shiny-apples-travel.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
---
"@clerk/backend": minor
---

Add `list()` method to M2M tokens API to retrieve a list of machine-to-machine tokens for a given machine.

```ts
// Retrieve M2M tokens for a specific machine
const response = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
});

console.log(response.data); // M2MToken[]
console.log(response.totalCount); // number
```

Filter by revoked or expired tokens:

```ts
const revokedTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
revoked: true,
});

const expiredTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
expired: true,
});
```
205 changes: 194 additions & 11 deletions packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,14 @@ import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('M2MToken', () => {
const m2mId = 'mt_xxxxx';
const m2mSecret = 'mt_secret_xxxxx';
const m2mId = 'mt_1xxxxxxxxxxxxx';
const m2mSecret = 'mt_secret_1xxxxxxxxxxxxx';

const mockM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
token: m2mSecret,
revoked: false,
Expand DownExpand Up@@ -46,7 +46,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -72,7 +72,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -116,8 +116,8 @@ describe('M2MToken', () => {
const mockRevokedM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
revoked: true,
revocation_reason: 'revoked by test',
Expand DownExpand Up@@ -151,7 +151,7 @@ describe('M2MToken', () => {
expect(response.revoked).toBe(true);
expect(response.token).toBeUndefined();
expect(response.revocationReason).toBe('revoked by test');
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -229,7 +229,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -255,7 +255,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -282,4 +282,187 @@ describe('M2MToken', () => {
expect(errResponse.status).toBe(401);
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
m2m_tokens: [
{
...mockM2MToken,
id: 'mt_1xxxxxxxxxxxxx',
},
{
...mockM2MToken,
id: 'mt_2xxxxxxxxxxxxx',
revoked: true,
},
],
total_count: 2,
};

it('lists m2m tokens with machine secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const url = new URL(request.url);
expect(url.searchParams.get('subject')).toBe(machineId);
expect(url.searchParams.get('limit')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 10,
});

expect(response.data).toHaveLength(2);
expect(response.data[0].id).toBe('mt_1xxxxxxxxxxxxx');
expect(response.data[1].id).toBe('mt_2xxxxxxxxxxxxx');
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with instance secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer sk_xxxxx');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with revoked filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('revoked')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
revoked: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with expired filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('expired')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
expired: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with pagination', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('limit')).toBe('5');
expect(url.searchParams.get('offset')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 5,
offset: 10,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('requires a machine secret or instance secret to list m2m tokens', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(() => {
return HttpResponse.json(
{
errors: [
{
message: 'Unauthorized',
code: 'unauthorized',
},
],
},
{ status: 401 },
);
}),
),
);

const errResponse = await apiClient.m2m
.list({
subject: machineId,
})
.catch(err => err);

expect(errResponse.status).toBe(401);
});
});
});
30 changes: 30 additions & 0 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
*/
subject: string;
/**
* Whether to include revoked machine-to-machine tokens.
*
* @default false
*/
revoked?: boolean;
/**
* Whether to include expired machine-to-machine tokens.
*
* @default false
*/
expired?: boolean;
}>;

type CreateM2MTokenParams = {
/**
* Custom machine secret key for authentication.
Expand DownExpand Up@@ -58,6 +80,14 @@ export class M2MTokenApi extends AbstractAPI {
return options;
}

async list(queryParams: GetM2MTokenListParams) {
return this.request<PaginatedResourceResponse<M2MToken[]>>({
method: 'GET',
path: basePath,
queryParams,
});
}
Comment thread
wobsoriano marked this conversation as resolved.

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};

Expand Down
27 changes: 27 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,12 @@ export function deserialize<U = any>(payload: unknown): PaginatedResourceRespons
if (Array.isArray(payload)) {
const data = payload.map(item => jsonToObject(item)) as U;
return { data };
} else if (isM2MTokenResponse(payload)) {
// Handle M2M token list responses with m2m_tokens property
data = payload.m2m_tokens.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;

return { data, totalCount };
Comment thread
wobsoriano marked this conversation as resolved.
} else if (isPaginated(payload)) {
data = payload.data.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;
Expand All@@ -95,6 +101,27 @@ function isPaginated(payload: unknown): payload is PaginatedResponseJSON {
return Array.isArray(payload.data) && payload.data !== undefined;
}

/**
* Detects M2M token list responses from the Backend API.
*
* The Clerk Backend API returns M2M token lists with `m2m_tokens` and `total_count` properties.
* This function identifies those responses and normalizes them to the standard `data` and
* `totalCount` format for consistency with other paginated API methods across the SDK.
*
* This approach avoids making breaking changes to BAPI Proxy or supporting both response
* formats. Once BAPI Proxy is updated to return the standard `data` property format,
* this function can be safely removed.
*
* @see https://clerk.com/docs/reference/backend-api/tag/m2m-tokens/get/m2m_tokens
*/
function isM2MTokenResponse(payload: unknown): payload is { m2m_tokens: unknown[]; total_count: number } {
if (!payload || typeof payload !== 'object' || !('m2m_tokens' in payload)) {
return false;
}

return Array.isArray(payload.m2m_tokens);
}

function getCount(item: PaginatedResponseJSON) {
return item.total_count;
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
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
29 changes: 29 additions & 0 deletions .changeset/shiny-apples-travel.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
---
"@clerk/backend": minor
---

Add `list()` method to M2M tokens API to retrieve a list of machine-to-machine tokens for a given machine.

```ts
// Retrieve M2M tokens for a specific machine
const response = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
});

console.log(response.data); // M2MToken[]
console.log(response.totalCount); // number
```

Filter by revoked or expired tokens:

```ts
const revokedTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
revoked: true,
});

const expiredTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
expired: true,
});
```
205 changes: 194 additions & 11 deletions packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,14 @@ import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('M2MToken', () => {
const m2mId = 'mt_xxxxx';
const m2mSecret = 'mt_secret_xxxxx';
const m2mId = 'mt_1xxxxxxxxxxxxx';
const m2mSecret = 'mt_secret_1xxxxxxxxxxxxx';

const mockM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
token: m2mSecret,
revoked: false,
Expand DownExpand Up@@ -46,7 +46,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -72,7 +72,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -116,8 +116,8 @@ describe('M2MToken', () => {
const mockRevokedM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
revoked: true,
revocation_reason: 'revoked by test',
Expand DownExpand Up@@ -151,7 +151,7 @@ describe('M2MToken', () => {
expect(response.revoked).toBe(true);
expect(response.token).toBeUndefined();
expect(response.revocationReason).toBe('revoked by test');
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -229,7 +229,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -255,7 +255,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -282,4 +282,187 @@ describe('M2MToken', () => {
expect(errResponse.status).toBe(401);
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
m2m_tokens: [
{
...mockM2MToken,
id: 'mt_1xxxxxxxxxxxxx',
},
{
...mockM2MToken,
id: 'mt_2xxxxxxxxxxxxx',
revoked: true,
},
],
total_count: 2,
};

it('lists m2m tokens with machine secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const url = new URL(request.url);
expect(url.searchParams.get('subject')).toBe(machineId);
expect(url.searchParams.get('limit')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 10,
});

expect(response.data).toHaveLength(2);
expect(response.data[0].id).toBe('mt_1xxxxxxxxxxxxx');
expect(response.data[1].id).toBe('mt_2xxxxxxxxxxxxx');
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with instance secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer sk_xxxxx');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with revoked filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('revoked')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
revoked: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with expired filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('expired')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
expired: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with pagination', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('limit')).toBe('5');
expect(url.searchParams.get('offset')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 5,
offset: 10,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('requires a machine secret or instance secret to list m2m tokens', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(() => {
return HttpResponse.json(
{
errors: [
{
message: 'Unauthorized',
code: 'unauthorized',
},
],
},
{ status: 401 },
);
}),
),
);

const errResponse = await apiClient.m2m
.list({
subject: machineId,
})
.catch(err => err);

expect(errResponse.status).toBe(401);
});
});
});
30 changes: 30 additions & 0 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
*/
subject: string;
/**
* Whether to include revoked machine-to-machine tokens.
*
* @default false
*/
revoked?: boolean;
/**
* Whether to include expired machine-to-machine tokens.
*
* @default false
*/
expired?: boolean;
}>;

type CreateM2MTokenParams = {
/**
* Custom machine secret key for authentication.
Expand DownExpand Up@@ -58,6 +80,14 @@ export class M2MTokenApi extends AbstractAPI {
return options;
}

async list(queryParams: GetM2MTokenListParams) {
return this.request<PaginatedResourceResponse<M2MToken[]>>({
method: 'GET',
path: basePath,
queryParams,
});
}
Comment thread
wobsoriano marked this conversation as resolved.

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};

Expand Down
27 changes: 27 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,12 @@ export function deserialize<U = any>(payload: unknown): PaginatedResourceRespons
if (Array.isArray(payload)) {
const data = payload.map(item => jsonToObject(item)) as U;
return { data };
} else if (isM2MTokenResponse(payload)) {
// Handle M2M token list responses with m2m_tokens property
data = payload.m2m_tokens.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;

return { data, totalCount };
Comment thread
wobsoriano marked this conversation as resolved.
} else if (isPaginated(payload)) {
data = payload.data.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;
Expand All@@ -95,6 +101,27 @@ function isPaginated(payload: unknown): payload is PaginatedResponseJSON {
return Array.isArray(payload.data) && payload.data !== undefined;
}

/**
* Detects M2M token list responses from the Backend API.
*
* The Clerk Backend API returns M2M token lists with `m2m_tokens` and `total_count` properties.
* This function identifies those responses and normalizes them to the standard `data` and
* `totalCount` format for consistency with other paginated API methods across the SDK.
*
* This approach avoids making breaking changes to BAPI Proxy or supporting both response
* formats. Once BAPI Proxy is updated to return the standard `data` property format,
* this function can be safely removed.
*
* @see https://clerk.com/docs/reference/backend-api/tag/m2m-tokens/get/m2m_tokens
*/
function isM2MTokenResponse(payload: unknown): payload is { m2m_tokens: unknown[]; total_count: number } {
if (!payload || typeof payload !== 'object' || !('m2m_tokens' in payload)) {
return false;
}

return Array.isArray(payload.m2m_tokens);
}

function getCount(item: PaginatedResponseJSON) {
return item.total_count;
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
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
29 changes: 29 additions & 0 deletions .changeset/shiny-apples-travel.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
---
"@clerk/backend": minor
---

Add `list()` method to M2M tokens API to retrieve a list of machine-to-machine tokens for a given machine.

```ts
// Retrieve M2M tokens for a specific machine
const response = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
});

console.log(response.data); // M2MToken[]
console.log(response.totalCount); // number
```

Filter by revoked or expired tokens:

```ts
const revokedTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
revoked: true,
});

const expiredTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
expired: true,
});
```
205 changes: 194 additions & 11 deletions packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,14 @@ import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('M2MToken', () => {
const m2mId = 'mt_xxxxx';
const m2mSecret = 'mt_secret_xxxxx';
const m2mId = 'mt_1xxxxxxxxxxxxx';
const m2mSecret = 'mt_secret_1xxxxxxxxxxxxx';

const mockM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
token: m2mSecret,
revoked: false,
Expand DownExpand Up@@ -46,7 +46,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -72,7 +72,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -116,8 +116,8 @@ describe('M2MToken', () => {
const mockRevokedM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
revoked: true,
revocation_reason: 'revoked by test',
Expand DownExpand Up@@ -151,7 +151,7 @@ describe('M2MToken', () => {
expect(response.revoked).toBe(true);
expect(response.token).toBeUndefined();
expect(response.revocationReason).toBe('revoked by test');
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -229,7 +229,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -255,7 +255,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -282,4 +282,187 @@ describe('M2MToken', () => {
expect(errResponse.status).toBe(401);
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
m2m_tokens: [
{
...mockM2MToken,
id: 'mt_1xxxxxxxxxxxxx',
},
{
...mockM2MToken,
id: 'mt_2xxxxxxxxxxxxx',
revoked: true,
},
],
total_count: 2,
};

it('lists m2m tokens with machine secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const url = new URL(request.url);
expect(url.searchParams.get('subject')).toBe(machineId);
expect(url.searchParams.get('limit')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 10,
});

expect(response.data).toHaveLength(2);
expect(response.data[0].id).toBe('mt_1xxxxxxxxxxxxx');
expect(response.data[1].id).toBe('mt_2xxxxxxxxxxxxx');
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with instance secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer sk_xxxxx');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with revoked filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('revoked')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
revoked: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with expired filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('expired')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
expired: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with pagination', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('limit')).toBe('5');
expect(url.searchParams.get('offset')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 5,
offset: 10,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('requires a machine secret or instance secret to list m2m tokens', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(() => {
return HttpResponse.json(
{
errors: [
{
message: 'Unauthorized',
code: 'unauthorized',
},
],
},
{ status: 401 },
);
}),
),
);

const errResponse = await apiClient.m2m
.list({
subject: machineId,
})
.catch(err => err);

expect(errResponse.status).toBe(401);
});
});
});
30 changes: 30 additions & 0 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
*/
subject: string;
/**
* Whether to include revoked machine-to-machine tokens.
*
* @default false
*/
revoked?: boolean;
/**
* Whether to include expired machine-to-machine tokens.
*
* @default false
*/
expired?: boolean;
}>;

type CreateM2MTokenParams = {
/**
* Custom machine secret key for authentication.
Expand DownExpand Up@@ -58,6 +80,14 @@ export class M2MTokenApi extends AbstractAPI {
return options;
}

async list(queryParams: GetM2MTokenListParams) {
return this.request<PaginatedResourceResponse<M2MToken[]>>({
method: 'GET',
path: basePath,
queryParams,
});
}
Comment thread
wobsoriano marked this conversation as resolved.

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};

Expand Down
27 changes: 27 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,12 @@ export function deserialize<U = any>(payload: unknown): PaginatedResourceRespons
if (Array.isArray(payload)) {
const data = payload.map(item => jsonToObject(item)) as U;
return { data };
} else if (isM2MTokenResponse(payload)) {
// Handle M2M token list responses with m2m_tokens property
data = payload.m2m_tokens.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;

return { data, totalCount };
Comment thread
wobsoriano marked this conversation as resolved.
} else if (isPaginated(payload)) {
data = payload.data.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;
Expand All@@ -95,6 +101,27 @@ function isPaginated(payload: unknown): payload is PaginatedResponseJSON {
return Array.isArray(payload.data) && payload.data !== undefined;
}

/**
* Detects M2M token list responses from the Backend API.
*
* The Clerk Backend API returns M2M token lists with `m2m_tokens` and `total_count` properties.
* This function identifies those responses and normalizes them to the standard `data` and
* `totalCount` format for consistency with other paginated API methods across the SDK.
*
* This approach avoids making breaking changes to BAPI Proxy or supporting both response
* formats. Once BAPI Proxy is updated to return the standard `data` property format,
* this function can be safely removed.
*
* @see https://clerk.com/docs/reference/backend-api/tag/m2m-tokens/get/m2m_tokens
*/
function isM2MTokenResponse(payload: unknown): payload is { m2m_tokens: unknown[]; total_count: number } {
if (!payload || typeof payload !== 'object' || !('m2m_tokens' in payload)) {
return false;
}

return Array.isArray(payload.m2m_tokens);
}

function getCount(item: PaginatedResponseJSON) {
return item.total_count;
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
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
29 changes: 29 additions & 0 deletions .changeset/shiny-apples-travel.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
---
"@clerk/backend": minor
---

Add `list()` method to M2M tokens API to retrieve a list of machine-to-machine tokens for a given machine.

```ts
// Retrieve M2M tokens for a specific machine
const response = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
});

console.log(response.data); // M2MToken[]
console.log(response.totalCount); // number
```

Filter by revoked or expired tokens:

```ts
const revokedTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
revoked: true,
});

const expiredTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
expired: true,
});
```
205 changes: 194 additions & 11 deletions packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,14 @@ import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('M2MToken', () => {
const m2mId = 'mt_xxxxx';
const m2mSecret = 'mt_secret_xxxxx';
const m2mId = 'mt_1xxxxxxxxxxxxx';
const m2mSecret = 'mt_secret_1xxxxxxxxxxxxx';

const mockM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
token: m2mSecret,
revoked: false,
Expand DownExpand Up@@ -46,7 +46,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -72,7 +72,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -116,8 +116,8 @@ describe('M2MToken', () => {
const mockRevokedM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
revoked: true,
revocation_reason: 'revoked by test',
Expand DownExpand Up@@ -151,7 +151,7 @@ describe('M2MToken', () => {
expect(response.revoked).toBe(true);
expect(response.token).toBeUndefined();
expect(response.revocationReason).toBe('revoked by test');
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -229,7 +229,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -255,7 +255,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -282,4 +282,187 @@ describe('M2MToken', () => {
expect(errResponse.status).toBe(401);
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
m2m_tokens: [
{
...mockM2MToken,
id: 'mt_1xxxxxxxxxxxxx',
},
{
...mockM2MToken,
id: 'mt_2xxxxxxxxxxxxx',
revoked: true,
},
],
total_count: 2,
};

it('lists m2m tokens with machine secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const url = new URL(request.url);
expect(url.searchParams.get('subject')).toBe(machineId);
expect(url.searchParams.get('limit')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 10,
});

expect(response.data).toHaveLength(2);
expect(response.data[0].id).toBe('mt_1xxxxxxxxxxxxx');
expect(response.data[1].id).toBe('mt_2xxxxxxxxxxxxx');
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with instance secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer sk_xxxxx');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with revoked filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('revoked')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
revoked: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with expired filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('expired')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
expired: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with pagination', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('limit')).toBe('5');
expect(url.searchParams.get('offset')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 5,
offset: 10,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('requires a machine secret or instance secret to list m2m tokens', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(() => {
return HttpResponse.json(
{
errors: [
{
message: 'Unauthorized',
code: 'unauthorized',
},
],
},
{ status: 401 },
);
}),
),
);

const errResponse = await apiClient.m2m
.list({
subject: machineId,
})
.catch(err => err);

expect(errResponse.status).toBe(401);
});
});
});
30 changes: 30 additions & 0 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
*/
subject: string;
/**
* Whether to include revoked machine-to-machine tokens.
*
* @default false
*/
revoked?: boolean;
/**
* Whether to include expired machine-to-machine tokens.
*
* @default false
*/
expired?: boolean;
}>;

type CreateM2MTokenParams = {
/**
* Custom machine secret key for authentication.
Expand DownExpand Up@@ -58,6 +80,14 @@ export class M2MTokenApi extends AbstractAPI {
return options;
}

async list(queryParams: GetM2MTokenListParams) {
return this.request<PaginatedResourceResponse<M2MToken[]>>({
method: 'GET',
path: basePath,
queryParams,
});
}
Comment thread
wobsoriano marked this conversation as resolved.

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};

Expand Down
27 changes: 27 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,12 @@ export function deserialize<U = any>(payload: unknown): PaginatedResourceRespons
if (Array.isArray(payload)) {
const data = payload.map(item => jsonToObject(item)) as U;
return { data };
} else if (isM2MTokenResponse(payload)) {
// Handle M2M token list responses with m2m_tokens property
data = payload.m2m_tokens.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;

return { data, totalCount };
Comment thread
wobsoriano marked this conversation as resolved.
} else if (isPaginated(payload)) {
data = payload.data.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;
Expand All@@ -95,6 +101,27 @@ function isPaginated(payload: unknown): payload is PaginatedResponseJSON {
return Array.isArray(payload.data) && payload.data !== undefined;
}

/**
* Detects M2M token list responses from the Backend API.
*
* The Clerk Backend API returns M2M token lists with `m2m_tokens` and `total_count` properties.
* This function identifies those responses and normalizes them to the standard `data` and
* `totalCount` format for consistency with other paginated API methods across the SDK.
*
* This approach avoids making breaking changes to BAPI Proxy or supporting both response
* formats. Once BAPI Proxy is updated to return the standard `data` property format,
* this function can be safely removed.
*
* @see https://clerk.com/docs/reference/backend-api/tag/m2m-tokens/get/m2m_tokens
*/
function isM2MTokenResponse(payload: unknown): payload is { m2m_tokens: unknown[]; total_count: number } {
if (!payload || typeof payload !== 'object' || !('m2m_tokens' in payload)) {
return false;
}

return Array.isArray(payload.m2m_tokens);
}

function getCount(item: PaginatedResponseJSON) {
return item.total_count;
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
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
29 changes: 29 additions & 0 deletions .changeset/shiny-apples-travel.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
---
"@clerk/backend": minor
---

Add `list()` method to M2M tokens API to retrieve a list of machine-to-machine tokens for a given machine.

```ts
// Retrieve M2M tokens for a specific machine
const response = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
});

console.log(response.data); // M2MToken[]
console.log(response.totalCount); // number
```

Filter by revoked or expired tokens:

```ts
const revokedTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
revoked: true,
});

const expiredTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
expired: true,
});
```
205 changes: 194 additions & 11 deletions packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,14 @@ import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('M2MToken', () => {
const m2mId = 'mt_xxxxx';
const m2mSecret = 'mt_secret_xxxxx';
const m2mId = 'mt_1xxxxxxxxxxxxx';
const m2mSecret = 'mt_secret_1xxxxxxxxxxxxx';

const mockM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
token: m2mSecret,
revoked: false,
Expand DownExpand Up@@ -46,7 +46,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -72,7 +72,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -116,8 +116,8 @@ describe('M2MToken', () => {
const mockRevokedM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
revoked: true,
revocation_reason: 'revoked by test',
Expand DownExpand Up@@ -151,7 +151,7 @@ describe('M2MToken', () => {
expect(response.revoked).toBe(true);
expect(response.token).toBeUndefined();
expect(response.revocationReason).toBe('revoked by test');
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -229,7 +229,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -255,7 +255,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -282,4 +282,187 @@ describe('M2MToken', () => {
expect(errResponse.status).toBe(401);
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
m2m_tokens: [
{
...mockM2MToken,
id: 'mt_1xxxxxxxxxxxxx',
},
{
...mockM2MToken,
id: 'mt_2xxxxxxxxxxxxx',
revoked: true,
},
],
total_count: 2,
};

it('lists m2m tokens with machine secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const url = new URL(request.url);
expect(url.searchParams.get('subject')).toBe(machineId);
expect(url.searchParams.get('limit')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 10,
});

expect(response.data).toHaveLength(2);
expect(response.data[0].id).toBe('mt_1xxxxxxxxxxxxx');
expect(response.data[1].id).toBe('mt_2xxxxxxxxxxxxx');
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with instance secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer sk_xxxxx');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with revoked filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('revoked')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
revoked: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with expired filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('expired')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
expired: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with pagination', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('limit')).toBe('5');
expect(url.searchParams.get('offset')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 5,
offset: 10,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('requires a machine secret or instance secret to list m2m tokens', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(() => {
return HttpResponse.json(
{
errors: [
{
message: 'Unauthorized',
code: 'unauthorized',
},
],
},
{ status: 401 },
);
}),
),
);

const errResponse = await apiClient.m2m
.list({
subject: machineId,
})
.catch(err => err);

expect(errResponse.status).toBe(401);
});
});
});
30 changes: 30 additions & 0 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
*/
subject: string;
/**
* Whether to include revoked machine-to-machine tokens.
*
* @default false
*/
revoked?: boolean;
/**
* Whether to include expired machine-to-machine tokens.
*
* @default false
*/
expired?: boolean;
}>;

type CreateM2MTokenParams = {
/**
* Custom machine secret key for authentication.
Expand DownExpand Up@@ -58,6 +80,14 @@ export class M2MTokenApi extends AbstractAPI {
return options;
}

async list(queryParams: GetM2MTokenListParams) {
return this.request<PaginatedResourceResponse<M2MToken[]>>({
method: 'GET',
path: basePath,
queryParams,
});
}
Comment thread
wobsoriano marked this conversation as resolved.

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};

Expand Down
27 changes: 27 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,12 @@ export function deserialize<U = any>(payload: unknown): PaginatedResourceRespons
if (Array.isArray(payload)) {
const data = payload.map(item => jsonToObject(item)) as U;
return { data };
} else if (isM2MTokenResponse(payload)) {
// Handle M2M token list responses with m2m_tokens property
data = payload.m2m_tokens.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;

return { data, totalCount };
Comment thread
wobsoriano marked this conversation as resolved.
} else if (isPaginated(payload)) {
data = payload.data.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;
Expand All@@ -95,6 +101,27 @@ function isPaginated(payload: unknown): payload is PaginatedResponseJSON {
return Array.isArray(payload.data) && payload.data !== undefined;
}

/**
* Detects M2M token list responses from the Backend API.
*
* The Clerk Backend API returns M2M token lists with `m2m_tokens` and `total_count` properties.
* This function identifies those responses and normalizes them to the standard `data` and
* `totalCount` format for consistency with other paginated API methods across the SDK.
*
* This approach avoids making breaking changes to BAPI Proxy or supporting both response
* formats. Once BAPI Proxy is updated to return the standard `data` property format,
* this function can be safely removed.
*
* @see https://clerk.com/docs/reference/backend-api/tag/m2m-tokens/get/m2m_tokens
*/
function isM2MTokenResponse(payload: unknown): payload is { m2m_tokens: unknown[]; total_count: number } {
if (!payload || typeof payload !== 'object' || !('m2m_tokens' in payload)) {
return false;
}

return Array.isArray(payload.m2m_tokens);
}

function getCount(item: PaginatedResponseJSON) {
return item.total_count;
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
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
29 changes: 29 additions & 0 deletions .changeset/shiny-apples-travel.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
---
"@clerk/backend": minor
---

Add `list()` method to M2M tokens API to retrieve a list of machine-to-machine tokens for a given machine.

```ts
// Retrieve M2M tokens for a specific machine
const response = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
});

console.log(response.data); // M2MToken[]
console.log(response.totalCount); // number
```

Filter by revoked or expired tokens:

```ts
const revokedTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
revoked: true,
});

const expiredTokens = await clerkClient.m2m.list({
subject: 'mch_1xxxxxxxxxxxxx',
expired: true,
});
```
205 changes: 194 additions & 11 deletions packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,14 @@ import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('M2MToken', () => {
const m2mId = 'mt_xxxxx';
const m2mSecret = 'mt_secret_xxxxx';
const m2mId = 'mt_1xxxxxxxxxxxxx';
const m2mSecret = 'mt_secret_1xxxxxxxxxxxxx';

const mockM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
token: m2mSecret,
revoked: false,
Expand DownExpand Up@@ -46,7 +46,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -72,7 +72,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -116,8 +116,8 @@ describe('M2MToken', () => {
const mockRevokedM2MToken = {
object: 'machine_to_machine_token',
id: m2mId,
subject: 'mch_xxxxx',
scopes: ['mch_1xxxxx', 'mch_2xxxxx'],
subject: 'mch_1xxxxxxxxxxxxx',
scopes: ['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx'],
claims: { foo: 'bar' },
revoked: true,
revocation_reason: 'revoked by test',
Expand DownExpand Up@@ -151,7 +151,7 @@ describe('M2MToken', () => {
expect(response.revoked).toBe(true);
expect(response.token).toBeUndefined();
expect(response.revocationReason).toBe('revoked by test');
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand DownExpand Up@@ -229,7 +229,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -255,7 +255,7 @@ describe('M2MToken', () => {

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
expect(response.claims).toEqual({ foo: 'bar' });
});

Expand All@@ -282,4 +282,187 @@ describe('M2MToken', () => {
expect(errResponse.status).toBe(401);
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
m2m_tokens: [
{
...mockM2MToken,
id: 'mt_1xxxxxxxxxxxxx',
},
{
...mockM2MToken,
id: 'mt_2xxxxxxxxxxxxx',
revoked: true,
},
],
total_count: 2,
};

it('lists m2m tokens with machine secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const url = new URL(request.url);
expect(url.searchParams.get('subject')).toBe(machineId);
expect(url.searchParams.get('limit')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 10,
});

expect(response.data).toHaveLength(2);
expect(response.data[0].id).toBe('mt_1xxxxxxxxxxxxx');
expect(response.data[1].id).toBe('mt_2xxxxxxxxxxxxx');
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with instance secret key', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer sk_xxxxx');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('lists m2m tokens with revoked filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('revoked')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
revoked: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with expired filter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('expired')).toBe('true');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
expired: true,
});

expect(response.data).toHaveLength(2);
});

it('lists m2m tokens with pagination', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'sk_xxxxx',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('limit')).toBe('5');
expect(url.searchParams.get('offset')).toBe('10');
return HttpResponse.json(mockM2MTokenList);
}),
),
);

const response = await apiClient.m2m.list({
subject: machineId,
limit: 5,
offset: 10,
});

expect(response.data).toHaveLength(2);
expect(response.totalCount).toBe(2);
});

it('requires a machine secret or instance secret to list m2m tokens', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.get(
'https://api.clerk.test/m2m_tokens',
validateHeaders(() => {
return HttpResponse.json(
{
errors: [
{
message: 'Unauthorized',
code: 'unauthorized',
},
],
},
{ status: 401 },
);
}),
),
);

const errResponse = await apiClient.m2m
.list({
subject: machineId,
})
.catch(err => err);

expect(errResponse.status).toBe(401);
});
});
});
30 changes: 30 additions & 0 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { joinPaths } from '../../util/path';
import { deprecated } from '../../util/shared';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
*/
subject: string;
/**
* Whether to include revoked machine-to-machine tokens.
*
* @default false
*/
revoked?: boolean;
/**
* Whether to include expired machine-to-machine tokens.
*
* @default false
*/
expired?: boolean;
}>;

type CreateM2MTokenParams = {
/**
* Custom machine secret key for authentication.
Expand DownExpand Up@@ -58,6 +80,14 @@ export class M2MTokenApi extends AbstractAPI {
return options;
}

async list(queryParams: GetM2MTokenListParams) {
return this.request<PaginatedResourceResponse<M2MToken[]>>({
method: 'GET',
path: basePath,
queryParams,
});
}
Comment thread
wobsoriano marked this conversation as resolved.

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};

Expand Down
27 changes: 27 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,6 +77,12 @@ export function deserialize<U = any>(payload: unknown): PaginatedResourceRespons
if (Array.isArray(payload)) {
const data = payload.map(item => jsonToObject(item)) as U;
return { data };
} else if (isM2MTokenResponse(payload)) {
// Handle M2M token list responses with m2m_tokens property
data = payload.m2m_tokens.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;

return { data, totalCount };
Comment thread
wobsoriano marked this conversation as resolved.
} else if (isPaginated(payload)) {
data = payload.data.map(item => jsonToObject(item)) as U;
totalCount = payload.total_count;
Expand All@@ -95,6 +101,27 @@ function isPaginated(payload: unknown): payload is PaginatedResponseJSON {
return Array.isArray(payload.data) && payload.data !== undefined;
}

/**
* Detects M2M token list responses from the Backend API.
*
* The Clerk Backend API returns M2M token lists with `m2m_tokens` and `total_count` properties.
* This function identifies those responses and normalizes them to the standard `data` and
* `totalCount` format for consistency with other paginated API methods across the SDK.
*
* This approach avoids making breaking changes to BAPI Proxy or supporting both response
* formats. Once BAPI Proxy is updated to return the standard `data` property format,
* this function can be safely removed.
*
* @see https://clerk.com/docs/reference/backend-api/tag/m2m-tokens/get/m2m_tokens
*/
function isM2MTokenResponse(payload: unknown): payload is { m2m_tokens: unknown[]; total_count: number } {
if (!payload || typeof payload !== 'object' || !('m2m_tokens' in payload)) {
return false;
}

return Array.isArray(payload.m2m_tokens);
}

function getCount(item: PaginatedResponseJSON) {
return item.total_count;
}
Expand Down
Loading