IOrganization
Represents an organization that services analytical workspaces.
export interface IOrganization
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| string | ID of organization. |
Methods
Method | Description |
|---|---|
(ALPHA) Returns service that can be used to query AI agent skills available in the organization. | |
(ALPHA) Returns service that can be used to query and manage automations across all workspaces in the organization for centralized automation management. | |
(ALPHA) Returns service that can be used to manage Content Security Policy directives of the organization. | |
(BETA) Returns service that can be used to query organization-level export templates for slide exports. | |
(ALPHA) Returns service that can be used to query and manage organization-level generative-AI resources. | |
Returns details about the organization. | |
(ALPHA) Returns current usage of the platform resources that the organization license can limit. | |
(ALPHA) Returns service that can be used to manage organization-level IP allowlist policies. | |
Returns service that can be used to query and manage organization LLM providers. | |
(ALPHA) Returns service that reports how languages and translations are used across the organization. | |
Returns service that can be used to query and manage organization notification channels. | |
Returns service that can be used to query and manage organization notifications. | |
Returns service that can be used to query and manage permissions to organization. | |
Returns service that can be used to query and update organization security settings. | |
Returns current organization settings. | |
Returns service that can be used to query and update organization styling. | |
Updates details about the organization. | |
Returns service that can be used to query and update organization users and user groups. |
Property details
IOrganization.organizationIdproperty
ID of organization.
readonly organizationId: string;
Method details
IOrganization.agents()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that can be used to query AI agent skills available in the organization.
agents(): IOrganizationAgentsService;
Returns
IOrganization.automations()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that can be used to query and manage automations across all workspaces in the organization for centralized automation management.
automations(): IOrganizationAutomationService;
Returns
IOrganization.cspDirectives()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that can be used to manage Content Security Policy directives of the organization.
cspDirectives(): IOrganizationCspDirectivesService;
Returns
IOrganization.exportTemplates()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Returns service that can be used to query organization-level export templates for slide exports.
exportTemplates(): IOrganizationExportTemplatesService;
Returns
IOrganization.genAI()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that can be used to query and manage organization-level generative-AI resources.
genAI(): IOrganizationGenAIService;
Returns
IOrganization.getDescriptor()method
Returns details about the organization.
getDescriptor(includeAdditionalDetails?: boolean): Promise<IOrganizationDescriptor>;
Parameters
Parameter | Type | Description |
|---|---|---|
includeAdditionalDetails | boolean | (Optional) include additional details such as bootstrap user and user group. |
Returns
Promise<IOrganizationDescriptor>
IOrganization.getPlatformUsage()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns current usage of the platform resources that the organization license can limit.
getPlatformUsage(): Promise<IPlatformUsage[]>;
Returns
Promise<IPlatformUsage[]>
IOrganization.ipAllowlists()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that can be used to manage organization-level IP allowlist policies.
ipAllowlists(): IOrganizationIpAllowlistService;
Returns
IOrganization.llmProviders()method
Returns service that can be used to query and manage organization LLM providers.
llmProviders(): IOrganizationLlmProvidersService;
Returns
IOrganization.localization()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that reports how languages and translations are used across the organization.
localization(): IOrganizationLocalizationService;
Returns
IOrganization.notificationChannels()method
Returns service that can be used to query and manage organization notification channels.
notificationChannels(): IOrganizationNotificationChannelService;
Returns
IOrganization.notifications()method
Returns service that can be used to query and manage organization notifications.
notifications(): IOrganizationNotificationService;
Returns
IOrganization.permissions()method
Returns service that can be used to query and manage permissions to organization.
permissions(): IOrganizationPermissionService;
Returns
IOrganization.securitySettings()method
Returns service that can be used to query and update organization security settings.
securitySettings(): ISecuritySettingsService;
Returns
IOrganization.settings()method
Returns current organization settings.
settings(): IOrganizationSettingsService;
Returns
IOrganization.styling()method
Returns service that can be used to query and update organization styling.
styling(): IOrganizationStylingService;
Returns
IOrganization.updateDescriptor()method
Updates details about the organization.
updateDescriptor(descriptor: IOrganizationDescriptorUpdate): Promise<IOrganizationDescriptor>;
Parameters
Parameter | Type | Description |
|---|---|---|
descriptor | properties to update |
Returns
Promise<IOrganizationDescriptor>
IOrganization.users()method
Returns service that can be used to query and update organization users and user groups.
users(): IOrganizationUserService;
Returns