@cubist-labs/cubesigner-sdk 0.3.26 → 0.3.28

package/dist/cjs/src/org_event_processor.js

@@ -0,0 +1,137 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _OrgEventProcessor_instances, _OrgEventProcessor_topicArn, _OrgEventProcessor_orgId, _OrgEventProcessor_cachedCertificates, _OrgEventProcessor_fetchAndValidateCertificate;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrgEventProcessor = void 0;
+const crypto_1 = require("crypto");
+const _1 = require(".");
+// URLs that are safe to retrieve certificates from
+const SNS_CERTIFICATE_URL_HOSTS = ["sns.us-east-1.amazonaws.com"];
+const SNS_CERTIFICATE_HOST = "sns.amazonaws.com";
+/** A utility for processing org event messages */
+class OrgEventProcessor {
+    /**
+     * Constructor.
+     * @param {string} orgId The org id
+     * @param {OrgEventProcessorOptions} options Additional options for the processor
+     */
+    constructor(orgId, options) {
+        _OrgEventProcessor_instances.add(this);
+        _OrgEventProcessor_topicArn.set(this, void 0);
+        _OrgEventProcessor_orgId.set(this, void 0);
+        _OrgEventProcessor_cachedCertificates.set(this, void 0);
+        __classPrivateFieldSet(this, _OrgEventProcessor_topicArn, _1.envs[options?.env ?? "prod"].OrgEventsTopicArn, "f");
+        __classPrivateFieldSet(this, _OrgEventProcessor_orgId, orgId, "f");
+        __classPrivateFieldSet(this, _OrgEventProcessor_cachedCertificates, new Map(), "f");
+    }
+    /**
+     * Checks an SNS message and its signature. Throws an error if the message
+     * invalid or the signature is invalid.
+     *
+     * @param {SnsMessage} message The SNS message to check
+     */
+    async checkMessage(message) {
+        // Check the topic ARN
+        if (message.TopicArn !== __classPrivateFieldGet(this, _OrgEventProcessor_topicArn, "f")) {
+            throw new Error(`Expected topic ARN '${__classPrivateFieldGet(this, _OrgEventProcessor_topicArn, "f")}', found '${message.TopicArn}'`);
+        }
+        // Both subscription confirmations and org event messages should have no subject
+        if ("Subject" in message) {
+            throw new Error("Expected a message without a subject");
+        }
+        // The org events topic uses signature version 2 (SHA256)
+        if (message.SignatureVersion !== "2") {
+            throw new Error("Expected signature version 2");
+        }
+        // Retrieve the certificate and sanity check it
+        const certificate = await __classPrivateFieldGet(this, _OrgEventProcessor_instances, "m", _OrgEventProcessor_fetchAndValidateCertificate).call(this, new URL(message.SigningCertURL));
+        // Extract fields specific to subscription confirmations
+        const subscribeUrl = message.SubscribeURL;
+        const token = message.Token;
+        // Check the signature
+        const fields = ["Message", message.Message, "MessageId", message.MessageId]
+            .concat(subscribeUrl !== undefined ? ["SubscribeURL", subscribeUrl] : [])
+            .concat(["Timestamp", message.Timestamp])
+            .concat(token !== undefined ? ["Token", token] : [])
+            .concat(["TopicArn", message.TopicArn, "Type", message.Type]);
+        const verify = (0, crypto_1.createVerify)("RSA-SHA256");
+        verify.update(fields.join("\n") + "\n");
+        const isValid = verify.verify(certificate.publicKey, message.Signature, "base64");
+        if (!isValid) {
+            throw new Error("The org event has an invalid signature");
+        }
+    }
+    /**
+     * Parse an org event and check its signature. Throws an error if the
+     * message is not a valid org event or the signature is invalid.
+     *
+     * @param {OrgEventMessage} message The org event message to check
+     * @return {OrgEventBase} The org event
+     */
+    async parse(message) {
+        await this.checkMessage(message);
+        // Check that the event is for the expected org
+        const orgEvent = JSON.parse(message.Message);
+        if (orgEvent.org !== __classPrivateFieldGet(this, _OrgEventProcessor_orgId, "f")) {
+            throw new Error(`Expected org to be '${__classPrivateFieldGet(this, _OrgEventProcessor_orgId, "f")}', found '${orgEvent.org}'`);
+        }
+        return orgEvent;
+    }
+}
+exports.OrgEventProcessor = OrgEventProcessor;
+_OrgEventProcessor_topicArn = new WeakMap(), _OrgEventProcessor_orgId = new WeakMap(), _OrgEventProcessor_cachedCertificates = new WeakMap(), _OrgEventProcessor_instances = new WeakSet(), _OrgEventProcessor_fetchAndValidateCertificate = 
+/**
+ * Fetches a certificate from a given URL or from the certificate cache.
+ * Throws an error if the URL does not correspond to an SNS certificate URL.
+ *
+ * Note: Ideally, this method would verify the certificate chain, but there
+ * is no obvious chain. Instead, this method only fetches certificates from
+ * a small set of allowlisted URLs.
+ *
+ * @param {URL} url The URL of the certificate
+ * @return {X509Certificate} The certificate
+ */
+async function _OrgEventProcessor_fetchAndValidateCertificate(url) {
+    const currTime = new Date().getTime();
+    const cachedCertificate = __classPrivateFieldGet(this, _OrgEventProcessor_cachedCertificates, "f").get(url);
+    if (cachedCertificate && currTime < new Date(cachedCertificate.validTo).getTime()) {
+        return cachedCertificate;
+    }
+    // Only fetch certificates from HTTPS URLs
+    if (url.protocol !== "https:") {
+        throw new Error("Expected signing certificate URL to use HTTPS");
+    }
+    // Only fetch certificate URLs for SNS
+    if (SNS_CERTIFICATE_URL_HOSTS.indexOf(url.host) === -1) {
+        throw new Error("Expected signing certificate URL for SNS in us-east-1");
+    }
+    const response = await fetch(url);
+    if (!response.ok) {
+        throw new Error(`Unable to download certificate. Status: ${response.status}`);
+    }
+    const blob = await response.blob();
+    const certificate = new crypto_1.X509Certificate(await blob.text());
+    if (!certificate.checkHost(SNS_CERTIFICATE_HOST)) {
+        throw new Error(`Expected certificate to be for '${SNS_CERTIFICATE_HOST}'`);
+    }
+    // Check validity times
+    if (currTime < new Date(certificate.validFrom).getTime()) {
+        throw new Error("Certificate not valid yet");
+    }
+    if (new Date(certificate.validTo).getTime() < currTime) {
+        throw new Error("Certificate expired");
+    }
+    __classPrivateFieldGet(this, _OrgEventProcessor_cachedCertificates, "f").set(url, certificate);
+    return certificate;
+};
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"org_event_processor.js","sourceRoot":"","sources":["../../../src/org_event_processor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,mCAAuD;AACvD,wBAAsC;AAEtC,mDAAmD;AACnD,MAAM,yBAAyB,GAAG,CAAC,6BAA6B,CAAC,CAAC;AAElE,MAAM,oBAAoB,GAAG,mBAAmB,CAAC;AAsCjD,kDAAkD;AAClD,MAAa,iBAAiB;IAK5B;;;;OAIG;IACH,YAAY,KAAa,EAAE,OAAkC;;QATpD,8CAAkB;QAClB,2CAAe;QACxB,wDAA+C;QAQ7C,uBAAA,IAAI,+BAAa,OAAI,CAAC,OAAO,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC,iBAAiB,MAAA,CAAC;QAChE,uBAAA,IAAI,4BAAU,KAAK,MAAA,CAAC;QACpB,uBAAA,IAAI,yCAAuB,IAAI,GAAG,EAAE,MAAA,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,OAAmB;QACpC,sBAAsB;QACtB,IAAI,OAAO,CAAC,QAAQ,KAAK,uBAAA,IAAI,mCAAU,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,uBAAuB,uBAAA,IAAI,mCAAU,aAAa,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACzF,CAAC;QAED,gFAAgF;QAChF,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,yDAAyD;QACzD,IAAI,OAAO,CAAC,gBAAgB,KAAK,GAAG,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QAED,+CAA+C;QAC/C,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,oFAA6B,MAAjC,IAAI,EAA8B,IAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;QAE7F,wDAAwD;QACxD,MAAM,YAAY,GAAI,OAA2C,CAAC,YAAY,CAAC;QAC/E,MAAM,KAAK,GAAI,OAA2C,CAAC,KAAK,CAAC;QAEjE,sBAAsB;QACtB,MAAM,MAAM,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC;aACxE,MAAM,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;aACxE,MAAM,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;aACxC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;aACnD,MAAM,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,IAAA,qBAAY,EAAC,YAAY,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClF,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,OAAwB;QAClC,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAEjC,+CAA+C;QAC/C,MAAM,QAAQ,GAAiB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC3D,IAAI,QAAQ,CAAC,GAAG,KAAK,uBAAA,IAAI,gCAAO,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,uBAAuB,uBAAA,IAAI,gCAAO,aAAa,QAAQ,CAAC,GAAG,GAAG,CAAC,CAAC;QAClF,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;CAmDF;AA/HD,8CA+HC;;AAjDC;;;;;;;;;;GAUG;AACH,KAAK,yDAA8B,GAAQ;IACzC,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;IACtC,MAAM,iBAAiB,GAAG,uBAAA,IAAI,6CAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5D,IAAI,iBAAiB,IAAI,QAAQ,GAAG,IAAI,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QAClF,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,0CAA0C;IAC1C,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IAED,sCAAsC;IACtC,IAAI,yBAAyB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,2CAA2C,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAChF,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACnC,MAAM,WAAW,GAAG,IAAI,wBAAe,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3D,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,KAAK,CAAC,mCAAmC,oBAAoB,GAAG,CAAC,CAAC;IAC9E,CAAC;IAED,uBAAuB;IACvB,IAAI,QAAQ,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QACzD,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IACD,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,GAAG,QAAQ,EAAE,CAAC;QACvD,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,uBAAA,IAAI,6CAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IAC/C,OAAO,WAAW,CAAC;AACrB,CAAC","sourcesContent":["import { X509Certificate, createVerify } from \"crypto\";\nimport { Environment, envs } from \".\";\n\n// URLs that are safe to retrieve certificates from\nconst SNS_CERTIFICATE_URL_HOSTS = [\"sns.us-east-1.amazonaws.com\"];\n\nconst SNS_CERTIFICATE_HOST = \"sns.amazonaws.com\";\n\n/** The common fields of SNS messages */\nexport interface SnsMessage {\n  Type: string;\n  MessageId: string;\n  TopicArn: string;\n  Message: string;\n  Timestamp: string;\n  SignatureVersion: string;\n  Signature: string;\n  SigningCertURL: string;\n}\n\n/** The format of a subscription confirmation sent by SNS */\nexport interface SubscriptionConfirmationMessage extends SnsMessage {\n  Token: string;\n  SubscribeURL: string;\n}\n\n/** Common fields for an org event */\nexport interface OrgEventBase {\n  org: string;\n  utc_timestamp: number;\n  org_event: string;\n}\n\n/** The format of an event message sent by SNS */\nexport interface OrgEventMessage extends SnsMessage {\n  Subject?: string;\n  UnsubscribeURL: string;\n}\n\n/** Options for the processor */\nexport interface OrgEventProcessorOptions {\n  env: Environment;\n}\n\n/** A utility for processing org event messages */\nexport class OrgEventProcessor {\n  readonly #topicArn: string;\n  readonly #orgId: string;\n  #cachedCertificates: Map<URL, X509Certificate>;\n\n  /**\n   * Constructor.\n   * @param {string} orgId The org id\n   * @param {OrgEventProcessorOptions} options Additional options for the processor\n   */\n  constructor(orgId: string, options?: OrgEventProcessorOptions) {\n    this.#topicArn = envs[options?.env ?? \"prod\"].OrgEventsTopicArn;\n    this.#orgId = orgId;\n    this.#cachedCertificates = new Map();\n  }\n\n  /**\n   * Checks an SNS message and its signature. Throws an error if the message\n   * invalid or the signature is invalid.\n   *\n   * @param {SnsMessage} message The SNS message to check\n   */\n  async checkMessage(message: SnsMessage) {\n    // Check the topic ARN\n    if (message.TopicArn !== this.#topicArn) {\n      throw new Error(`Expected topic ARN '${this.#topicArn}', found '${message.TopicArn}'`);\n    }\n\n    // Both subscription confirmations and org event messages should have no subject\n    if (\"Subject\" in message) {\n      throw new Error(\"Expected a message without a subject\");\n    }\n\n    // The org events topic uses signature version 2 (SHA256)\n    if (message.SignatureVersion !== \"2\") {\n      throw new Error(\"Expected signature version 2\");\n    }\n\n    // Retrieve the certificate and sanity check it\n    const certificate = await this.#fetchAndValidateCertificate(new URL(message.SigningCertURL));\n\n    // Extract fields specific to subscription confirmations\n    const subscribeUrl = (message as SubscriptionConfirmationMessage).SubscribeURL;\n    const token = (message as SubscriptionConfirmationMessage).Token;\n\n    // Check the signature\n    const fields = [\"Message\", message.Message, \"MessageId\", message.MessageId]\n      .concat(subscribeUrl !== undefined ? [\"SubscribeURL\", subscribeUrl] : [])\n      .concat([\"Timestamp\", message.Timestamp])\n      .concat(token !== undefined ? [\"Token\", token] : [])\n      .concat([\"TopicArn\", message.TopicArn, \"Type\", message.Type]);\n    const verify = createVerify(\"RSA-SHA256\");\n    verify.update(fields.join(\"\\n\") + \"\\n\");\n    const isValid = verify.verify(certificate.publicKey, message.Signature, \"base64\");\n    if (!isValid) {\n      throw new Error(\"The org event has an invalid signature\");\n    }\n  }\n\n  /**\n   * Parse an org event and check its signature. Throws an error if the\n   * message is not a valid org event or the signature is invalid.\n   *\n   * @param {OrgEventMessage} message The org event message to check\n   * @return {OrgEventBase} The org event\n   */\n  async parse(message: OrgEventMessage): Promise<OrgEventBase> {\n    await this.checkMessage(message);\n\n    // Check that the event is for the expected org\n    const orgEvent: OrgEventBase = JSON.parse(message.Message);\n    if (orgEvent.org !== this.#orgId) {\n      throw new Error(`Expected org to be '${this.#orgId}', found '${orgEvent.org}'`);\n    }\n\n    return orgEvent;\n  }\n\n  /**\n   * Fetches a certificate from a given URL or from the certificate cache.\n   * Throws an error if the URL does not correspond to an SNS certificate URL.\n   *\n   * Note: Ideally, this method would verify the certificate chain, but there\n   * is no obvious chain. Instead, this method only fetches certificates from\n   * a small set of allowlisted URLs.\n   *\n   * @param {URL} url The URL of the certificate\n   * @return {X509Certificate} The certificate\n   */\n  async #fetchAndValidateCertificate(url: URL): Promise<X509Certificate> {\n    const currTime = new Date().getTime();\n    const cachedCertificate = this.#cachedCertificates.get(url);\n    if (cachedCertificate && currTime < new Date(cachedCertificate.validTo).getTime()) {\n      return cachedCertificate;\n    }\n\n    // Only fetch certificates from HTTPS URLs\n    if (url.protocol !== \"https:\") {\n      throw new Error(\"Expected signing certificate URL to use HTTPS\");\n    }\n\n    // Only fetch certificate URLs for SNS\n    if (SNS_CERTIFICATE_URL_HOSTS.indexOf(url.host) === -1) {\n      throw new Error(\"Expected signing certificate URL for SNS in us-east-1\");\n    }\n\n    const response = await fetch(url);\n    if (!response.ok) {\n      throw new Error(`Unable to download certificate. Status: ${response.status}`);\n    }\n    const blob = await response.blob();\n    const certificate = new X509Certificate(await blob.text());\n    if (!certificate.checkHost(SNS_CERTIFICATE_HOST)) {\n      throw new Error(`Expected certificate to be for '${SNS_CERTIFICATE_HOST}'`);\n    }\n\n    // Check validity times\n    if (currTime < new Date(certificate.validFrom).getTime()) {\n      throw new Error(\"Certificate not valid yet\");\n    }\n    if (new Date(certificate.validTo).getTime() < currTime) {\n      throw new Error(\"Certificate expired\");\n    }\n\n    this.#cachedCertificates.set(url, certificate);\n    return certificate;\n  }\n}\n"]}

package/dist/cjs/src/schema.d.ts

@@ -184,7 +184,11 @@ export interface paths {
          * Update Key
          * @description Update Key
          *
-         * Enable or disable a key.  The user must be the owner of the key or organization to perform this action.
+         * Enable or disable a key.  The user must be the owner of the key or
+         * organization to perform this action.
+         *
+         * For each requested update, the session must have the corresponding 'manage:key:update:_' scope;
+         * if no updates are requested, the session must have 'manage:key:get'.
          */
         patch: operations["updateKey"];
     };
@@ -1005,7 +1009,7 @@ export interface components {
         /** @enum {string} */
         BadGatewayErrorCode: "OAuthProviderError";
         /** @enum {string} */
-        BadRequestErrorCode: "GenericBadRequest" | "InvalidBody" | "TokenRequestError" | "InvalidMfaReceipt" | "InvalidMfaPolicyCount" | "InvalidMfaPolicyNumAuthFactors" | "InvalidMfaPolicyNumAllowedApprovers" | "InvalidMfaPolicyRedundantRule" | "InvalidCreateKeyCount" | "OrgInviteExistingUser" | "OrgNameTaken" | "RoleNameTaken" | "AddKeyToRoleCountTooHigh" | "InvalidKeyId" | "InvalidKeyMetadataLength" | "InvalidKeyMetadata" | "InvalidKeyMaterialId" | "KeyNotFound" | "UserExportDerivedKey" | "UserExportPublicKeyInvalid" | "UserExportInProgress" | "RoleNotFound" | "InvalidMfaReceiptOrgIdMissing" | "InvalidMfaReceiptInvalidOrgId" | "MfaRequestNotFound" | "InvalidKeyType" | "InvalidKeyMaterial" | "InvalidHexValue" | "InvalidBase32Value" | "InvalidBase58Value" | "InvalidForkVersionLength" | "InvalidEthAddress" | "InvalidStellarAddress" | "InvalidOrgNameOrId" | "InvalidStakeDeposit" | "InvalidBlobSignRequest" | "InvalidSolanaSignRequest" | "InvalidEip712SignRequest" | "InvalidEvmSignRequest" | "InvalidEth2SignRequest" | "InvalidDeriveKeyRequest" | "InvalidStakingAmount" | "CustomStakingAmountNotAllowedForWrapperContract" | "InvalidUnstakeRequest" | "InvalidCreateUserRequest" | "UserAlreadyExists" | "UserNotFound" | "PolicyRuleKeyMismatch" | "EmptyScopes" | "InvalidScopesForRoleSession" | "InvalidLifetime" | "NoSingleKeyForUser" | "InvalidOrgPolicyRule" | "SourceIpAllowlistEmpty" | "InvalidOrgPolicyRepeatedRule" | "AvaSignHashError" | "AvaSignError" | "BtcSegwitHashError" | "BtcSignError" | "Eip712SignError" | "InvalidMemberRoleInUserAdd" | "ThirdPartyUserAlreadyExists" | "ThirdPartyUserNotFound" | "DeleteOidcUserError" | "SessionRoleMismatch" | "InvalidOidcToken" | "OidcIssuerUnsupported" | "OidcIssuerNotAllowed" | "OidcIssuerNoApplicableJwk" | "FidoKeyAlreadyRegistered" | "FidoKeySignCountTooLow" | "FidoVerificationFailed" | "FidoChallengeMfaMismatch" | "UnsupportedLegacyCognitoSession" | "InvalidIdentityProof" | "PaginationDataExpired" | "ExistingKeysViolateExclusiveKeyAccess" | "ExportDelayTooShort" | "ExportWindowTooLong" | "InvalidTotpFailureLimit" | "InvalidEip191SignRequest" | "CannotResendUserInvitation" | "InvalidNotificationEndpointCount" | "CannotDeletePendingSubscription" | "InvalidNotificationUrlProtocol" | "EmptyOneOfOrgEventFilter" | "EmptyAllExceptOrgEventFilter";
+        BadRequestErrorCode: "GenericBadRequest" | "InvalidBody" | "TokenRequestError" | "InvalidMfaReceipt" | "InvalidMfaPolicyCount" | "InvalidMfaPolicyNumAuthFactors" | "InvalidMfaPolicyNumAllowedApprovers" | "InvalidMfaPolicyRedundantRule" | "InvalidCreateKeyCount" | "OrgInviteExistingUser" | "OrgNameTaken" | "RoleNameTaken" | "AddKeyToRoleCountTooHigh" | "InvalidKeyId" | "InvalidUpdate" | "InvalidMetadataLength" | "InvalidKeyMaterialId" | "KeyNotFound" | "UserExportDerivedKey" | "UserExportPublicKeyInvalid" | "UserExportInProgress" | "RoleNotFound" | "InvalidMfaReceiptOrgIdMissing" | "InvalidMfaReceiptInvalidOrgId" | "MfaRequestNotFound" | "InvalidKeyType" | "InvalidKeyMaterial" | "InvalidHexValue" | "InvalidBase32Value" | "InvalidBase58Value" | "InvalidForkVersionLength" | "InvalidEthAddress" | "InvalidStellarAddress" | "InvalidOrgNameOrId" | "InvalidStakeDeposit" | "InvalidBlobSignRequest" | "InvalidSolanaSignRequest" | "InvalidEip712SignRequest" | "InvalidEvmSignRequest" | "InvalidEth2SignRequest" | "InvalidDeriveKeyRequest" | "InvalidStakingAmount" | "CustomStakingAmountNotAllowedForWrapperContract" | "InvalidUnstakeRequest" | "InvalidCreateUserRequest" | "UserAlreadyExists" | "UserNotFound" | "PolicyRuleKeyMismatch" | "EmptyScopes" | "InvalidScopesForRoleSession" | "InvalidLifetime" | "NoSingleKeyForUser" | "InvalidOrgPolicyRule" | "SourceIpAllowlistEmpty" | "InvalidOrgPolicyRepeatedRule" | "AvaSignHashError" | "AvaSignError" | "BtcSegwitHashError" | "BtcSignError" | "Eip712SignError" | "InvalidMemberRoleInUserAdd" | "ThirdPartyUserAlreadyExists" | "ThirdPartyUserNotFound" | "DeleteOidcUserError" | "SessionRoleMismatch" | "InvalidOidcToken" | "OidcIssuerUnsupported" | "OidcIssuerNotAllowed" | "OidcIssuerNoApplicableJwk" | "FidoKeyAlreadyRegistered" | "FidoKeySignCountTooLow" | "FidoVerificationFailed" | "FidoChallengeMfaMismatch" | "UnsupportedLegacyCognitoSession" | "InvalidIdentityProof" | "PaginationDataExpired" | "ExistingKeysViolateExclusiveKeyAccess" | "ExportDelayTooShort" | "ExportWindowTooLong" | "InvalidTotpFailureLimit" | "InvalidEip191SignRequest" | "CannotResendUserInvitation" | "InvalidNotificationEndpointCount" | "CannotDeletePendingSubscription" | "InvalidNotificationUrlProtocol" | "EmptyOneOfOrgEventFilter" | "EmptyAllExceptOrgEventFilter";
         /**
          * @example {
          *   "message_base64": "YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXoxMjM0NTYK"
@@ -1093,6 +1097,22 @@ export interface components {
             /** @description Session ID */
             session_id: string;
         };
+        /** @description Fields that are common to different types of resources such as keys */
+        CommonFields: {
+            created?: components["schemas"]["EpochDateTime"] | null;
+            last_modified?: components["schemas"]["EpochDateTime"] | null;
+            /**
+             * @description User-defined metadata. When rendering (e.g., in the browser) you should treat
+             * it as untrusted user data (and avoid injecting metadata into HTML directly) if
+             * untrusted users can create/update keys (or their metadata).
+             */
+            metadata?: unknown;
+            /**
+             * Format: int64
+             * @description Version of this object
+             */
+            version?: number;
+        };
         ConfiguredMfa: {
             /** @enum {string} */
             type: "totp";
@@ -1106,10 +1126,10 @@ export interface components {
         };
         CreateAndUpdateKeyProperties: {
             /**
-             * @description Set this key's metadata. Validation regex: ^[A-Za-z0-9_=+/ \-\.\,]{0,1024}$
-             * @example Contract admin key
+             * @description Set this key's metadata. If this value is `null`, the metadata is erased. If the field is
+             * missing, the metadata remains unchanged.
              */
-            metadata?: string | null;
+            metadata?: unknown;
             /**
              * @description Specify a user other than themselves to be the (potentially new) owner of the key.
              * The specified owner must be an existing user who is a member of the same org.
@@ -1854,7 +1874,7 @@ export interface components {
              */
             role_id: string;
         };
-        KeyInfo: {
+        KeyInfo: components["schemas"]["CommonFields"] & {
             derivation_info?: components["schemas"]["KeyDerivationInfo"] | null;
             /** @description Whether the key is enabled (only enabled keys may be used for signing) */
             enabled: boolean;
@@ -1870,12 +1890,6 @@ export interface components {
              * @example 0x8e3484687e66cdd26cf04c3647633ab4f3570148
              */
             material_id: string;
-            /**
-             * @description User-defined metadata. When rendering (e.g., in the browser) you should treat
-             * it as untrusted user data (and avoid injecting metadata into HTML directly) if
-             * untrusted users can create/update keys (or their metadata).
-             */
-            metadata?: string;
             /**
              * @description Owner of the key
              * @example User#c3b9379c-4e8c-4216-bd0a-65ace53cf98f
@@ -2895,6 +2909,11 @@ export interface components {
              * Once disabled, a key cannot be used for signing.
              */
             enabled?: boolean | null;
+            /**
+             * Format: int64
+             * @description If set, updating the metadata only succeeds if the version matches this value.
+             */
+            version?: number | null;
         };
         UpdateOrgRequest: {
             /** @description If set, update this org's `enabled` field to this value. */
@@ -3152,10 +3171,10 @@ export interface components {
         };
         UserInOrgInfo: {
             /**
-             * @description The user's email
+             * @description The user's email (optional)
              * @example alice@example.com
              */
-            email: string;
+            email?: string | null;
             /**
              * @description The id of the user
              * @example User#c3b9379c-4e8c-4216-bd0a-65ace53cf98f
@@ -3185,7 +3204,7 @@ export interface components {
              * @description Optional email
              * @example alice@example.com
              */
-            email: string;
+            email?: string | null;
             /** @description All multi-factor authentication methods configured for this user */
             mfa: components["schemas"]["ConfiguredMfa"][];
             /** @description MFA policy, applies before logging in and other sensitive operations */
@@ -3450,7 +3469,7 @@ export interface components {
         };
         KeyInfo: {
             content: {
-                "application/json": {
+                "application/json": components["schemas"]["CommonFields"] & {
                     derivation_info?: components["schemas"]["KeyDerivationInfo"] | null;
                     /** @description Whether the key is enabled (only enabled keys may be used for signing) */
                     enabled: boolean;
@@ -3466,12 +3485,6 @@ export interface components {
                      * @example 0x8e3484687e66cdd26cf04c3647633ab4f3570148
                      */
                     material_id: string;
-                    /**
-                     * @description User-defined metadata. When rendering (e.g., in the browser) you should treat
-                     * it as untrusted user data (and avoid injecting metadata into HTML directly) if
-                     * untrusted users can create/update keys (or their metadata).
-                     */
-                    metadata?: string;
                     /**
                      * @description Owner of the key
                      * @example User#c3b9379c-4e8c-4216-bd0a-65ace53cf98f
@@ -4020,7 +4033,7 @@ export interface components {
                      * @description Optional email
                      * @example alice@example.com
                      */
-                    email: string;
+                    email?: string | null;
                     /** @description All multi-factor authentication methods configured for this user */
                     mfa: components["schemas"]["ConfiguredMfa"][];
                     /** @description MFA policy, applies before logging in and other sensitive operations */
@@ -4633,7 +4646,11 @@ export interface operations {
      * Update Key
      * @description Update Key
      *
-     * Enable or disable a key.  The user must be the owner of the key or organization to perform this action.
+     * Enable or disable a key.  The user must be the owner of the key or
+     * organization to perform this action.
+     *
+     * For each requested update, the session must have the corresponding 'manage:key:update:_' scope;
+     * if no updates are requested, the session must have 'manage:key:get'.
      */
     updateKey: {
         parameters: {