Skip to main content

Secret

Datalayer Core

Datalayer Core / Secret

Class: Secret

Defined in: src/models/Secret.ts:163

Secret domain model for the Datalayer SDK. Provides state management and operations for user secrets.

Example​

const secret = await sdk.createSecret({
  variant: 'password',
  name: 'db_password',
  description: 'Production DB password',
  value: 'my-secure-password'
});

await secret.update({ description: 'Updated description' });
await secret.delete();

Constructors​

Constructor​

new Secret(data, sdk): SecretDTO

Defined in: src/models/Secret.ts:174

Create a Secret instance.

Parameters​

data​

SecretData

Secret data from API

sdk​

DatalayerClient

SDK instance

Returns​

SecretDTO

Properties​

_data​

_data: SecretData

Defined in: src/models/Secret.ts:165

Internal

Accessors​

description​

Get Signature​

get description(): string

Defined in: src/models/Secret.ts:225

Returns​

string

name​

Get Signature​

get name(): string

Defined in: src/models/Secret.ts:220

Returns​

string

uid​

Get Signature​

get uid(): string

Defined in: src/models/Secret.ts:210

Returns​

string

value​

Get Signature​

get value(): string

Defined in: src/models/Secret.ts:231

Returns decoded (plain text) secret value

Returns​

string

variant​

Get Signature​

get variant(): ISecretVariant

Defined in: src/models/Secret.ts:215

Returns​

ISecretVariant

Methods​

delete()​

delete(): Promise<void>

Defined in: src/models/Secret.ts:254

Delete this secret permanently.

Returns​

Promise<void>

rawData()​

rawData(): SecretData

Defined in: src/models/Secret.ts:283

Get raw secret data exactly as received from API.

Returns​

SecretData

toJSON()​

toJSON(): SecretJSON

Defined in: src/models/Secret.ts:267

Get secret data in camelCase format.

Returns​

SecretJSON

toString()​

toString(): string

Defined in: src/models/Secret.ts:288

Returns​

string

update()​

update(updates): Promise<SecretDTO>

Defined in: src/models/Secret.ts:245

Update this secret.

Parameters​

updates​

UpdateSecretRequest

Fields to update

Returns​

Promise<SecretDTO>

Updated Secret instance