JavaScript

Example: Secrets.SecretSpecToJson method

Demonstrates the SecretSpecToJson method. This method converts a secret specification string to the JSON required to create or lookup the secret. JavaScript

var success = false;

var secrets = new CkSecrets();
var json = new CkJsonObject();
json.EmitCompact = false;

// A secret name can include up to 4 components:
// [appName] / service / [domain] / username

// This example will demonstrate secret specification strings
// for each possible combination.

// ------------------------------------------------------
// 1: service + username
var sspec = "!!imap|john@example.com";

secrets.SecretSpecToJson(sspec,json);
console.log(json.Emit());

// Result:
// {
//   "service": "imap",
//   "username": "john@example.com"
// }

// ------------------------------------------------------
// 2: appName + service + username
sspec = "!!myApp|imap|john@example.com";

secrets.SecretSpecToJson(sspec,json);
console.log(json.Emit());

// Result:
// {
//   "appName": "myApp",
//   "service": "imap",
//   "username": "john@example.com"
// }

// ------------------------------------------------------
// 3: service + domain + username
sspec = "!!|imap|imap.example.com|john";

secrets.SecretSpecToJson(sspec,json);
console.log(json.Emit());

// Result:
// {
//   "service": "imap",
//   "domain": "imap.example.com",
//   "username": "john"
// }

// ------------------------------------------------------
// 4: appName + service + domain + username
sspec = "!!myApp|imap|imap.example.com|john";

secrets.SecretSpecToJson(sspec,json);
console.log(json.Emit());

// Result:
// {
//   "appName": "myApp",
//   "service": "imap",
//   "domain": "imap.example.com",
//   "username": "john"
// }