ClientConfig is a type in @cipherstash/stack. TypeScript API reference with its signature, parameters, and usage.

Type Alias: ClientConfig

type ClientConfig = {
  workspaceCrn?: string;
  accessKey?: string;
  clientId?: string;
  clientKey?: string;
  keyset?: KeysetIdentifier;
};

Defined in: packages/stack/src/types.ts:57

Properties

workspaceCrn?

optional workspaceCrn: string;

Defined in: packages/stack/src/types.ts:63

The CipherStash workspace CRN (Cloud Resource Name). Format: crn:<region>.aws:<workspace-id>. Can also be set via the CS_WORKSPACE_CRN environment variable.

accessKey?

optional accessKey: string;

Defined in: packages/stack/src/types.ts:70

The API access key used for authenticating with the CipherStash API. Can also be set via the CS_CLIENT_ACCESS_KEY environment variable. Obtain this from the CipherStash dashboard after creating a workspace.

clientId?

optional clientId: string;

Defined in: packages/stack/src/types.ts:77

The client identifier used to authenticate with CipherStash services. Can also be set via the CS_CLIENT_ID environment variable. Generated during workspace onboarding in the CipherStash dashboard.

clientKey?

optional clientKey: string;

Defined in: packages/stack/src/types.ts:84

The client key material used in combination with ZeroKMS for encryption operations. Can also be set via the CS_CLIENT_KEY environment variable. Generated during workspace onboarding in the CipherStash dashboard.

keyset?

optional keyset: KeysetIdentifier;

Defined in: packages/stack/src/types.ts:92

An optional keyset identifier for multi-tenant encryption. Each keyset provides cryptographic isolation, giving each tenant its own keyspace. Specify by name ({ name: "tenant-a" }) or UUID ({ id: "..." }). Keysets are created and managed in the CipherStash dashboard.

ClientConfig