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
14 changes: 14 additions & 0 deletions .changeset/kind-ravens-collect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
"@clerk/backend": patch
---

Support `min_remaining_ttl_seconds` for M2M token creation.

Usage:

```ts
clerkClient.m2m.createToken({
machineSecretKey: 'ak_xxxxx',
minRemainingTtlSeconds: 240,
})
```
10 changes: 8 additions & 2 deletions packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,18 @@ describe('M2MToken', () => {
server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.min_remaining_ttl_seconds).toBe(240);
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
secondsUntilExpiration: 3600,
minRemainingTtlSeconds: 240,
});

expect(response.id).toBe(m2mId);
Expand All @@ -62,8 +65,10 @@ describe('M2MToken', () => {
server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(({ request }) => {
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.min_remaining_ttl_seconds).toBe(240);
return HttpResponse.json(mockM2MToken);
}),
),
Expand All @@ -72,6 +77,7 @@ describe('M2MToken', () => {
const response = await apiClient.m2m.createToken({
machineSecretKey: 'ak_xxxxx',
secondsUntilExpiration: 3600,
minRemainingTtlSeconds: 240,
});

expect(response.id).toBe(m2mId);
Expand Down
14 changes: 13 additions & 1 deletion packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ type CreateM2MTokenParams = {
*/
secondsUntilExpiration?: number | null;
claims?: Record<string, unknown> | null;
/**
* Enables server-side token reuse for opaque tokens when an existing token
* with matching claims/scopes still has at least this many seconds remaining.
*/
minRemainingTtlSeconds?: number;
/**
* @default 'opaque'
*/
Expand Down Expand Up @@ -127,7 +132,13 @@ export class M2MTokenApi extends AbstractAPI {
}

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

const requestOptions = this.#createRequestOptions(
{
Expand All @@ -136,6 +147,7 @@ export class M2MTokenApi extends AbstractAPI {
bodyParams: {
secondsUntilExpiration,
claims,
minRemainingTtlSeconds,
tokenFormat,
},
},
Expand Down
Loading