Class: AIGatewayOrganisationsClient

Defined in: src/ai-gateway/organisations-client.ts:26

Client for AI Gateway organisation settings (admin plane).

Constructors

Constructor

new AIGatewayOrganisationsClient(opts): AIGatewayOrganisationsClient;

Defined in: src/ai-gateway/organisations-client.ts:31

Parameters

Parameter	Type
`opts`	`AIGatewaySubClientOptions`

Returns

AIGatewayOrganisationsClient

Methods

getInfo()

getInfo(tsgId): Promise<objectOutputType<{
  id: ZodString;
  name: ZodString;
  object: ZodString;
  created_at: ZodString;
  last_updated_at: ZodString;
  is_first_generation_done: ZodNumber;
  disable_portkey_gateway: ZodNumber;
  settings: ZodObject<{
     dashboard_gateway_url: ZodString;
     dashboard_mcp_gateway_url: ZodString;
     debug_log: ZodNumber;
     user_api_key_count: ZodNumber;
     user_api_key_ttl: ZodNumber;
     user_api_key_max_ttl: ZodNumber;
     user_key_metadata: ZodNumber;
     user_key_metadata_override: ZodNumber;
     user_api_key_rotation_period: ZodUnknown;
     user_api_key_auto_create: ZodBoolean;
     default_workspace_user_api_key_auto_create: ZodBoolean;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     dashboard_gateway_url: ZodString;
     dashboard_mcp_gateway_url: ZodString;
     debug_log: ZodNumber;
     user_api_key_count: ZodNumber;
     user_api_key_ttl: ZodNumber;
     user_api_key_max_ttl: ZodNumber;
     user_key_metadata: ZodNumber;
     user_key_metadata_override: ZodNumber;
     user_api_key_rotation_period: ZodUnknown;
     user_api_key_auto_create: ZodBoolean;
     default_workspace_user_api_key_auto_create: ZodBoolean;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     dashboard_gateway_url: ZodString;
     dashboard_mcp_gateway_url: ZodString;
     debug_log: ZodNumber;
     user_api_key_count: ZodNumber;
     user_api_key_ttl: ZodNumber;
     user_api_key_max_ttl: ZodNumber;
     user_key_metadata: ZodNumber;
     user_key_metadata_override: ZodNumber;
     user_api_key_rotation_period: ZodUnknown;
     user_api_key_auto_create: ZodBoolean;
     default_workspace_user_api_key_auto_create: ZodBoolean;
  }, ZodTypeAny, "passthrough">>;
  benefits: ZodObject<{
     limits: ZodRecord<ZodString, ZodNumber>;
     featureFlags: ZodRecord<ZodString, ZodUnion<[ZodNumber, ZodArray<ZodString, "many">]>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     limits: ZodRecord<ZodString, ZodNumber>;
     featureFlags: ZodRecord<ZodString, ZodUnion<[ZodNumber, ZodArray<ZodString, "many">]>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     limits: ZodRecord<ZodString, ZodNumber>;
     featureFlags: ZodRecord<ZodString, ZodUnion<[ZodNumber, ZodArray<ZodString, "many">]>>;
  }, ZodTypeAny, "passthrough">>;
  subscription: ZodObject<{
     type: ZodString;
     name: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     type: ZodString;
     name: ZodString;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     type: ZodString;
     name: ZodString;
  }, ZodTypeAny, "passthrough">>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/organisations-client.ts:38

Organisation capabilities/settings (bare response, not getSelf's envelope).

Parameters

Parameter	Type
`tsgId`	`string`

Returns

Promise<objectOutputType<{ id: ZodString; name: ZodString; object: ZodString; created_at: ZodString; last_updated_at: ZodString; is_first_generation_done: ZodNumber; disable_portkey_gateway: ZodNumber; settings: ZodObject<{ dashboard_gateway_url: ZodString; dashboard_mcp_gateway_url: ZodString; debug_log: ZodNumber; user_api_key_count: ZodNumber; user_api_key_ttl: ZodNumber; user_api_key_max_ttl: ZodNumber; user_key_metadata: ZodNumber; user_key_metadata_override: ZodNumber; user_api_key_rotation_period: ZodUnknown; user_api_key_auto_create: ZodBoolean; default_workspace_user_api_key_auto_create: ZodBoolean; }, "passthrough", ZodTypeAny, objectOutputType<{ dashboard_gateway_url: ZodString; dashboard_mcp_gateway_url: ZodString; debug_log: ZodNumber; user_api_key_count: ZodNumber; user_api_key_ttl: ZodNumber; user_api_key_max_ttl: ZodNumber; user_key_metadata: ZodNumber; user_key_metadata_override: ZodNumber; user_api_key_rotation_period: ZodUnknown; user_api_key_auto_create: ZodBoolean; default_workspace_user_api_key_auto_create: ZodBoolean; }, ZodTypeAny, "passthrough">, objectInputType<{ dashboard_gateway_url: ZodString; dashboard_mcp_gateway_url: ZodString; debug_log: ZodNumber; user_api_key_count: ZodNumber; user_api_key_ttl: ZodNumber; user_api_key_max_ttl: ZodNumber; user_key_metadata: ZodNumber; user_key_metadata_override: ZodNumber; user_api_key_rotation_period: ZodUnknown; user_api_key_auto_create: ZodBoolean; default_workspace_user_api_key_auto_create: ZodBoolean; }, ZodTypeAny, "passthrough">>; benefits: ZodObject<{ limits: ZodRecord<ZodString, ZodNumber>; featureFlags: ZodRecord<ZodString, ZodUnion<[ZodNumber, ZodArray<ZodString, "many">]>>; }, "passthrough", ZodTypeAny, objectOutputType<{ limits: ZodRecord<ZodString, ZodNumber>; featureFlags: ZodRecord<ZodString, ZodUnion<[ZodNumber, ZodArray<ZodString, "many">]>>; }, ZodTypeAny, "passthrough">, objectInputType<{ limits: ZodRecord<ZodString, ZodNumber>; featureFlags: ZodRecord<ZodString, ZodUnion<[ZodNumber, ZodArray<ZodString, "many">]>>; }, ZodTypeAny, "passthrough">>; subscription: ZodObject<{ type: ZodString; name: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ type: ZodString; name: ZodString; }, ZodTypeAny, "passthrough">, objectInputType<{ type: ZodString; name: ZodString; }, ZodTypeAny, "passthrough">>; }, ZodTypeAny, "passthrough">>

Example

`await gw.organisations.getInfo('1852583913');`

getSelf()

getSelf(): Promise<objectOutputType<{
  success: ZodBoolean;
  data: ZodRecord<ZodString, ZodUnknown>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/organisations-client.ts:63

Fetch the calling organisation's settings.

Returns

Promise<objectOutputType<{ success: ZodBoolean; data: ZodRecord<ZodString, ZodUnknown>; }, ZodTypeAny, "passthrough">>

The organisation record.

Example

import { AIGatewayClient } from '@cdot65/prisma-airs-sdk';
const gw = new AIGatewayClient();

const org = await gw.organisations.getSelf();
// org.data.name => 'Acme Corp'

updateSelf()

updateSelf(body): Promise<objectOutputType<{
  id: ZodOptional<ZodString>;
  slug: ZodOptional<ZodString>;
  version_id: ZodOptional<ZodString>;
  success: ZodOptional<ZodBoolean>;
  data: ZodOptional<ZodUnion<[ZodObject<{
     id: ZodOptional<ZodString>;
     slug: ZodOptional<ZodString>;
     version_id: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodOptional<ZodString>;
     slug: ZodOptional<ZodString>;
     version_id: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodOptional<ZodString>;
     slug: ZodOptional<ZodString>;
     version_id: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/organisations-client.ts:86

Update the calling organisation's settings.

Parameters

Parameter	Type	Description
`body`	{ [`key`: `string`]: `any`; }	One or more fields to update.

Returns

Promise<objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; success: ZodOptional<ZodBoolean>; data: ZodOptional<ZodUnion<[ZodObject<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>; }, ZodTypeAny, "passthrough">>

The raw update response. Shape unverified against a live tenant — see the PRD.

Example

import { AIGatewayClient } from '@cdot65/prisma-airs-sdk';
const gw = new AIGatewayClient();

await gw.organisations.updateSelf({ name: 'Acme Corp' });

getAuthSettings()

getAuthSettings(tsgId): Promise<objectOutputType<{
  success: ZodBoolean;
  data: ZodRecord<ZodString, ZodUnknown>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/organisations-client.ts:118

Fetch an organisation's auth settings.

Parameters

Parameter	Type	Description
`tsgId`	`string`	The TSG as a numeric string, not a UUID.

Returns

Promise<objectOutputType<{ success: ZodBoolean; data: ZodRecord<ZodString, ZodUnknown>; }, ZodTypeAny, "passthrough">>

Auth settings, including domains and the SCIM token.

Remarks

The response includes a scim_token — a live secret. Never log the returned object. SDK debug logs redact scim_token and known nested client-secret fields. Callers must still avoid logging the input object or returned auth settings directly.

Example

import { AIGatewayClient } from '@cdot65/prisma-airs-sdk';
const gw = new AIGatewayClient();

const auth = await gw.organisations.getAuthSettings('1852583913');
// Object.keys(auth.data) => ['auth_settings', 'domains', 'scim_token', ...]

updateAuthSettings()

updateAuthSettings(tsgId, body): Promise<objectOutputType<{
  id: ZodOptional<ZodString>;
  slug: ZodOptional<ZodString>;
  version_id: ZodOptional<ZodString>;
  success: ZodOptional<ZodBoolean>;
  data: ZodOptional<ZodUnion<[ZodObject<{
     id: ZodOptional<ZodString>;
     slug: ZodOptional<ZodString>;
     version_id: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodOptional<ZodString>;
     slug: ZodOptional<ZodString>;
     version_id: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodOptional<ZodString>;
     slug: ZodOptional<ZodString>;
     version_id: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/organisations-client.ts:146

Update an organisation's auth settings.

Parameters

Parameter	Type	Description
`tsgId`	`string`	The TSG as a numeric string, not a UUID.
`body`	{ [`key`: `string`]: `any`; }	One or more auth-setting fields to update.

Returns

The raw update response. Shape unverified against a live tenant — see the PRD.

Example

import { AIGatewayClient } from '@cdot65/prisma-airs-sdk';
const gw = new AIGatewayClient();

await gw.organisations.updateAuthSettings('1852583913', {
  domains: ['acme.com'],
});

Constructors​

Constructor​

Parameters​

Returns​

Methods​

getInfo()​

Parameters​

Returns​

Example​

getSelf()​

Returns​

Example​

updateSelf()​

Parameters​

Returns​

Example​

getAuthSettings()​

Parameters​

Returns​

Remarks​

Example​

updateAuthSettings()​

Parameters​

Returns​

Example​

Constructors

Constructor

Parameters

Returns

Methods

getInfo()

Parameters

Returns

Example

getSelf()

Returns

Example

updateSelf()

Parameters

Returns

Example

getAuthSettings()

Parameters

Returns

Remarks

Example

updateAuthSettings()

Parameters

Returns

Example