Class: AIGatewayOrganisationsClient

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

Client for AI Gateway organisation settings (admin plane).

Constructors

Constructor

new AIGatewayOrganisationsClient(opts): AIGatewayOrganisationsClient;

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

Parameters

Parameter	Type
opts	AIGatewaySubClientOptions

Returns

AIGatewayOrganisationsClient

Methods

getSelf()

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

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

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<{
}, ZodTypeAny, "passthrough">>;

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

Update the calling organisation's settings.

Parameters

Parameter	Type	Description
body	Record<string, unknown>	Replacement fields.

Returns

Promise<objectOutputType<{ }, 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:93

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. Note that setting PANW_AI_SEC_DEBUG will print it (unredacted) to the SDK's own debug log regardless of this warning, since debug logging only sanitizes header values.

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<{
}, ZodTypeAny, "passthrough">>;

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

Update an organisation's auth settings.

Parameters

Parameter	Type	Description
tsgId	string	The TSG as a numeric string, not a UUID.
body	Record<string, unknown>	Replacement fields.

Returns

Promise<objectOutputType<{ }, 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.updateAuthSettings('1852583913', {
  domains: ['acme.com'],
});