Class: AIGatewaySecretReferencesClient

Defined in: src/ai-gateway/secret-references-client.ts:28

Organisation-level secret-reference CRUD on the SCM admin plane. Never resolves an external secret.

Example

`const client = new AIGatewayClient().secretReferences;`

Constructors

Constructor

new AIGatewaySecretReferencesClient(options): AIGatewaySecretReferencesClient;

Defined in: src/ai-gateway/secret-references-client.ts:29

Parameters

Parameter	Type
options	AIGatewaySubClientOptions

Returns

AIGatewaySecretReferencesClient

Methods

list()

list(opts?): Promise<{
[key: string]: unknown;
  object?: string;
  total?: number;
  data?: {
   [key: string]: unknown;
     id?: string;
     name?: string;
     slug?: string;
     manager_type?: string;
     status?: string;
     created_at?: string;
     last_updated_at?: string;
     object?: string;
  }[];
}>;

Defined in: src/ai-gateway/secret-references-client.ts:35

List All Secret References. Verified on an isolated SCM fixture, 2026-09-06.

Parameters

Parameter	Type
opts	{ manager_type?: "aws_sm" | "azure_kv" | "hashicorp_vault"; tags?: string; search?: string; current_page?: number; page_size?: number; }
opts.manager_type?	"aws_sm" | "azure_kv" | "hashicorp_vault"
opts.tags?	string
opts.search?	string
opts.current_page?	number
opts.page_size?	number

Returns

Promise<{ [key: string]: unknown; object?: string; total?: number; data?: { [key: string]: unknown; id?: string; name?: string; slug?: string; manager_type?: string; status?: string; created_at?: string; last_updated_at?: string; object?: string; }[]; }>

Example

`await gw.secretReferences.list({});`

---

create()

create(body): Promise<{
[key: string]: unknown;
  id?: string;
  slug?: string;
  object?: string;
}>;

Defined in: src/ai-gateway/secret-references-client.ts:54

Create a Secret Reference. Verified on an isolated SCM fixture, 2026-09-06.

Parameters

Parameter	Type
body	{ organisation_id?: string; name: string; slug?: string; description?: string | null; manager_type: "aws_sm" | "azure_kv" | "hashicorp_vault"; auth_config: | { aws_auth_type: "accessKey"; aws_access_key_id: string; aws_secret_access_key: string; aws_region: string; } | { aws_auth_type: "assumedRole"; aws_role_arn: string; aws_external_id?: string | null; aws_region: string; } | { aws_auth_type: "serviceRole"; aws_region?: string; } | { azure_auth_mode: "entra"; azure_entra_tenant_id: string; azure_entra_client_id: string; azure_entra_client_secret: string; azure_vault_url: string; } | { azure_auth_mode: "managed"; azure_managed_client_id?: string; azure_vault_url: string; } | { azure_auth_mode: "default"; azure_vault_url: string; } | { vault_auth_type: "token"; vault_addr: string; vault_token: string; vault_namespace?: string; } | { vault_auth_type: "approle"; vault_addr: string; vault_role_id: string; vault_secret_id: string; vault_namespace?: string; } | { vault_auth_type: "kubernetes"; vault_addr: string; vault_role: string; vault_namespace?: string; }; secret_path: string; secret_key?: string | null; allow_all_workspaces?: boolean; allowed_workspaces?: string[]; tags?: | { [key: string]: string; } | null; }
body.organisation_id?	string
body.name	string
body.slug?	string
body.description?	string | null
body.manager_type	"aws_sm" | "azure_kv" | "hashicorp_vault"
body.auth_config	| { aws_auth_type: "accessKey"; aws_access_key_id: string; aws_secret_access_key: string; aws_region: string; } | { aws_auth_type: "assumedRole"; aws_role_arn: string; aws_external_id?: string | null; aws_region: string; } | { aws_auth_type: "serviceRole"; aws_region?: string; } | { azure_auth_mode: "entra"; azure_entra_tenant_id: string; azure_entra_client_id: string; azure_entra_client_secret: string; azure_vault_url: string; } | { azure_auth_mode: "managed"; azure_managed_client_id?: string; azure_vault_url: string; } | { azure_auth_mode: "default"; azure_vault_url: string; } | { vault_auth_type: "token"; vault_addr: string; vault_token: string; vault_namespace?: string; } | { vault_auth_type: "approle"; vault_addr: string; vault_role_id: string; vault_secret_id: string; vault_namespace?: string; } | { vault_auth_type: "kubernetes"; vault_addr: string; vault_role: string; vault_namespace?: string; }
body.secret_path	string
body.secret_key?	string | null
body.allow_all_workspaces?	boolean
body.allowed_workspaces?	string[]
body.tags?	| { [key: string]: string; } | null

Returns

Promise<{ [key: string]: unknown; id?: string; slug?: string; object?: string; }>

Example

`await gw.secretReferences.create(body);`

---

get()

get(secretReferenceId): Promise<{
[key: string]: unknown;
  id?: string;
  organisation_id?: string;
  name?: string;
  slug?: string;
  description?: string | null;
  manager_type?: string;
  secret_path?: string;
  secret_key?: string | null;
  allow_all_workspaces?: boolean;
  tags?:   | {
   [key: string]: string;
   }
     | null;
  status?: string;
  created_by?: string;
  created_at?: string;
  last_updated_at?: string;
  auth_config?: {
   [key: string]: unknown;
  };
  object?: string;
}>;

Defined in: src/ai-gateway/secret-references-client.ts:74

Get a Secret Reference. Verified on an isolated SCM fixture, 2026-09-06.

Parameters

Parameter	Type
secretReferenceId	string

Returns

Promise<{ [key: string]: unknown; id?: string; organisation_id?: string; name?: string; slug?: string; description?: string | null; manager_type?: string; secret_path?: string; secret_key?: string | null; allow_all_workspaces?: boolean; tags?: | { [key: string]: string; } | null; status?: string; created_by?: string; created_at?: string; last_updated_at?: string; auth_config?: { [key: string]: unknown; }; object?: string; }>

Example

`await gw.secretReferences.get('resource-id');`

---

update()

update(secretReferenceId, body): Promise<{
[key: string]: unknown;
}>;

Defined in: src/ai-gateway/secret-references-client.ts:91

Update a Secret Reference. Verified on an isolated SCM fixture, 2026-09-06.

Parameters

Parameter	Type
secretReferenceId	string
body	{ name?: string; description?: string | null; auth_config?: { [key: string]: GatewayJsonValue; }; secret_path?: string; secret_key?: string | null; allow_all_workspaces?: boolean; allowed_workspaces?: string[]; tags?: | { [key: string]: string; } | null; }
body.name?	string
body.description?	string | null
body.auth_config?	{ [key: string]: GatewayJsonValue; }
body.secret_path?	string
body.secret_key?	string | null
body.allow_all_workspaces?	boolean
body.allowed_workspaces?	string[]
body.tags?	| { [key: string]: string; } | null

Returns

Promise<{ [key: string]: unknown; }>

Example

`await gw.secretReferences.update('resource-id', body);`

---

delete()

delete(secretReferenceId): Promise<{
[key: string]: unknown;
}>;

Defined in: src/ai-gateway/secret-references-client.ts:113

Delete a Secret Reference. Verified on an isolated SCM fixture, 2026-09-06.

Parameters

Parameter	Type
secretReferenceId	string

Returns

Promise<{ [key: string]: unknown; }>

Example

`await gw.secretReferences.delete('resource-id');`