Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-12595

Docs for SERVER-39895: Write shell JS API for interacting with key vault

      Description

      Description:

      The FLE project will require enterprise documentation changes. With this change, you can create a Keystore object in the shell by calling
      ```
      var mongo = new Mongo();
      var keystore = mongo.getKeyStore();
      ```

      The rest of the functionality is outlined in src/fle/shell/keystore.js in the enterprise module.

      Engineering Ticket Description:

      Write JS API to generate KMS keys, add/remove alt names, query keys, and delete keys

      Proposed API:

      class KeyStore {
          createKey(keyAltName : string[]) : any {}
          getKey(keyId : UUID) : any {}
          deleteKey(keyId : UUID) : void {}
          getKeys() : any[] {}
          addKeyAlternateName(keyId : UUID, keyAltName : string) : any {}
          removeKeyAlternateName(keyId : UUID, keyAltName : string) : any {}
      };
      

      Scope of changes

      Impact to Other Docs

      MVP (Work and Date)

      Resources (Scope or Design Docs, Invision, etc.)

            Assignee:
            Unassigned Unassigned
            Reporter:
            kay.kim@mongodb.com Kay Kim (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved:
              4 years, 41 weeks, 2 days ago