[DOCS-12595] Docs for SERVER-39895: Write shell JS API for interacting with key vault Created: 02/Apr/19  Updated: 13/Nov/23  Resolved: 08/Jul/19

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 4.1.10, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Unassigned
Resolution: Duplicate Votes: 0
Labels: docs-4.2-client-side-encryption, docs-fle
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-39895 Write shell JS API for interacting wi... Closed
Duplicate
Participants:
Days since reply: 4 years, 31 weeks, 2 days ago
Epic Link: DOCS: 4.2 Server/Tools

 Description   

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.)



 Comments   
Comment by Ravind Kumar (Inactive) [ 08/Jul/19 ]

Merged into DOCS-12715

 

Generated at Thu Feb 08 08:05:38 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.