Class: SecretsResource#

Defined in: sdk-js/src/v4/resources/secrets.ts:28

client.secrets.* — write-only secret store, scoped to the authenticated user. Values are referenced from workflow nodes via {{secrets.NAME}} template variables and are decrypted server-side at execution time; the SDK never receives the plaintext value back.

put is a single idempotent endpoint replacing v3's create + update split — sending the same name twice rotates the value silently rather than erroring.

Constructors#

Constructor#

new SecretsResource(transport: Transport): SecretsResource;

Defined in: sdk-js/src/v4/resources/secrets.ts:29

Parameters#

ParameterType
transportTransport

Returns#

SecretsResource

Methods#

list()#

list(params?: ListSecretsParams): Promise<{
  data: readonly object[];
  pageInfo: {
     hasNextPage: boolean;
     hasPreviousPage: boolean;
     startCursor?: string;
     endCursor?: string;
  };
}>;

Defined in: sdk-js/src/v4/resources/secrets.ts:32

GET /secrets — metadata only; values are write-only.

Parameters#

ParameterType
params?ListSecretsParams

Returns#

Promise<{ data: readonly object[]; pageInfo: { hasNextPage: boolean; hasPreviousPage: boolean; startCursor?: string; endCursor?: string; }; }>

put()#

put(name: string, body: object): Promise<void>;

Defined in: sdk-js/src/v4/resources/secrets.ts:40

PUT /secrets/ — idempotent create-or-replace.

Parameters#

ParameterTypeDescription
namestring-
body{ value: string; workflowId?: string; orgId?: string; }-
body.valuestringDescription Secret value (write-only, never echoed back).
body.workflowId?string-
body.orgId?string-

Returns#

Promise<void>

delete()#

delete(name: string, params?: DeleteSecretParams): Promise<void>;

Defined in: sdk-js/src/v4/resources/secrets.ts:49

DELETE /secrets/

Parameters#

ParameterType
namestring
params?DeleteSecretParams

Returns#

Promise<void>