@clerk/backend 3.0.0-canary.v20251210190209 → 3.0.0-canary.v20251210190938

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,7 @@
1
1
  import type { ClerkPaginationRequest } from '@clerk/shared/types';
2
2
  import type { PaginatedResourceResponse } from '../../api/resources/Deserializer';
3
3
  import type { APIKey } from '../resources/APIKey';
4
+ import type { DeletedObject } from '../resources/DeletedObject';
4
5
  import { AbstractAPI } from './AbstractApi';
5
6
  type GetAPIKeyListParams = ClerkPaginationRequest<{
6
7
  /**
@@ -42,9 +43,29 @@ type RevokeAPIKeyParams = {
42
43
  */
43
44
  revocationReason?: string | null;
44
45
  };
46
+ type UpdateAPIKeyParams = {
47
+ /**
48
+ * API key ID
49
+ */
50
+ apiKeyId: string;
51
+ /**
52
+ * The user or Organization ID to associate the API key with
53
+ */
54
+ subject: string;
55
+ /**
56
+ * API key description
57
+ */
58
+ description?: string | null;
59
+ claims?: Record<string, any> | null;
60
+ scopes?: string[];
61
+ secondsUntilExpiration?: number | null;
62
+ };
45
63
  export declare class APIKeysAPI extends AbstractAPI {
46
64
  list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>>;
47
65
  create(params: CreateAPIKeyParams): Promise<APIKey>;
66
+ get(apiKeyId: string): Promise<APIKey>;
67
+ update(params: UpdateAPIKeyParams): Promise<APIKey>;
68
+ delete(apiKeyId: string): Promise<DeletedObject>;
48
69
  revoke(params: RevokeAPIKeyParams): Promise<APIKey>;
49
70
  getSecret(apiKeyId: string): Promise<{
50
71
  secret: string;
@@ -1 +1 @@
1
- {"version":3,"file":"APIKeysApi.d.ts","sourceRoot":"","sources":["../../../src/api/endpoints/APIKeysApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAElE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAGlF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAI5C,KAAK,mBAAmB,GAAG,sBAAsB,CAAC;IAChD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC,CAAC;AAEH,KAAK,kBAAkB,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IACpC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC,CAAC;AAEF,qBAAa,UAAW,SAAQ,WAAW;IACnC,IAAI,CAAC,WAAW,EAAE,mBAAmB;IAQrC,MAAM,CAAC,MAAM,EAAE,kBAAkB;IAQjC,MAAM,CAAC,MAAM,EAAE,kBAAkB;IAYjC,SAAS,CAAC,QAAQ,EAAE,MAAM;gBAGA,MAAM;;IAMhC,MAAM,CAAC,MAAM,EAAE,MAAM;IAQ3B;;OAEG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM;CAIlC"}
1
+ {"version":3,"file":"APIKeysApi.d.ts","sourceRoot":"","sources":["../../../src/api/endpoints/APIKeysApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAElE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAGlF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAI5C,KAAK,mBAAmB,GAAG,sBAAsB,CAAC;IAChD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC,CAAC;AAEH,KAAK,kBAAkB,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IACpC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IACpC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC,CAAC;AAEF,qBAAa,UAAW,SAAQ,WAAW;IACnC,IAAI,CAAC,WAAW,EAAE,mBAAmB;IAQrC,MAAM,CAAC,MAAM,EAAE,kBAAkB;IAQjC,GAAG,CAAC,QAAQ,EAAE,MAAM;IASpB,MAAM,CAAC,MAAM,EAAE,kBAAkB;IAYjC,MAAM,CAAC,QAAQ,EAAE,MAAM;IASvB,MAAM,CAAC,MAAM,EAAE,kBAAkB;IAYjC,SAAS,CAAC,QAAQ,EAAE,MAAM;gBAGA,MAAM;;IAMhC,MAAM,CAAC,MAAM,EAAE,MAAM;IAQ3B;;OAEG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM;CAIlC"}
@@ -31,7 +31,7 @@ import {
31
31
  // src/constants.ts
32
32
  var API_URL = "https://api.clerk.com";
33
33
  var API_VERSION = "v1";
34
- var USER_AGENT = `${"@clerk/backend"}@${"3.0.0-canary.v20251210190209"}`;
34
+ var USER_AGENT = `${"@clerk/backend"}@${"3.0.0-canary.v20251210190938"}`;
35
35
  var MAX_CACHE_LAST_UPDATED_AT_SECONDS = 5 * 60;
36
36
  var SUPPORTED_BAPI_VERSION = "2025-11-10";
37
37
  var Attributes = {
@@ -542,13 +542,36 @@ var APIKeysAPI = class extends AbstractAPI {
542
542
  bodyParams: params
543
543
  });
544
544
  }
545
- async revoke(params) {
545
+ async get(apiKeyId) {
546
+ this.requireId(apiKeyId);
547
+ return this.request({
548
+ method: "GET",
549
+ path: joinPaths(basePath4, apiKeyId)
550
+ });
551
+ }
552
+ async update(params) {
546
553
  const { apiKeyId, ...bodyParams } = params;
547
554
  this.requireId(apiKeyId);
555
+ return this.request({
556
+ method: "PATCH",
557
+ path: joinPaths(basePath4, apiKeyId),
558
+ bodyParams
559
+ });
560
+ }
561
+ async delete(apiKeyId) {
562
+ this.requireId(apiKeyId);
563
+ return this.request({
564
+ method: "DELETE",
565
+ path: joinPaths(basePath4, apiKeyId)
566
+ });
567
+ }
568
+ async revoke(params) {
569
+ const { apiKeyId, revocationReason = null } = params;
570
+ this.requireId(apiKeyId);
548
571
  return this.request({
549
572
  method: "POST",
550
573
  path: joinPaths(basePath4, apiKeyId, "revoke"),
551
- bodyParams
574
+ bodyParams: { revocationReason }
552
575
  });
553
576
  }
554
577
  async getSecret(apiKeyId) {
@@ -5674,4 +5697,4 @@ export {
5674
5697
  debugRequestState,
5675
5698
  createAuthenticateRequest
5676
5699
  };
5677
- //# sourceMappingURL=chunk-5XNHVJUL.mjs.map
5700
+ //# sourceMappingURL=chunk-MWRPJ7XC.mjs.map