FlagsSDKKeyWithSecrets

Representation of a Flags SDK key returned by CREATE. Includes cleartext secrets (keyValue, tokenValue, connectionString) which are only ever disclosed once, on creation.

Example Usage

import { FlagsSDKKeyWithSecrets } from "@vercel/sdk/models/flagssdkkeywithsecrets.js";

let value: FlagsSDKKeyWithSecrets = {
  hashKey: "<value>",
  projectId: "<id>",
  type: "client",
  environment: "<value>",
  createdBy: "<value>",
  createdAt: 3191.79,
  updatedAt: 1860.8,
  partialKeyValue: "<value>",
  keyValue: "<value>",
};

Fields

Field	Type	Required	Description
hashKey	string	:heavy_check_mark:	N/A
projectId	string	:heavy_check_mark:	N/A
type	models.FlagsSDKKeyWithSecretsType	:heavy_check_mark:	N/A
environment	string	:heavy_check_mark:	N/A
createdBy	string	:heavy_check_mark:	N/A
createdAt	number	:heavy_check_mark:	N/A
updatedAt	number	:heavy_check_mark:	N/A
label	string	:heavy_minus_sign:	N/A
deletedAt	number	:heavy_minus_sign:	N/A
partialKeyValue	string	:heavy_check_mark:	Partially-masked representation of the SDK key value, safe to display in UIs. The value is the vf_<type>_ prefix followed by the first 3 characters of the secret portion and a fixed 8-character * mask (e.g. vf_server_abc********).
keyValue	string	:heavy_check_mark:	Cleartext value of the SDK key.
tokenValue	string	:heavy_minus_sign:	Cleartext value of the Edge Config token, when the project has an Edge Config connection.