1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. OrganizationMetadata

OrganizationMetadata

    OrganizationMetadata contains configuration, subscription, and feature information for an organization.

    Properties

    • id string required
      The unique identifier of the organization.
    • kind enum required
      The kind of backing identity provider for the organization.
      Values: single-user, bitbucket, github, gitlab, pulumi, saml
    • created string required
      The time the organization was created.
    • backingOrgLogin string optional
      The login name of the backing organization on the identity provider.
    • product enum optional
      Subscription-related information if the organization has a Pulumi subscription. Otherwise, assume it is a grandfathered TeamPerStack org or in the Community Edition.
      Values: team-per-stack, community, individual, team-starter, team-pro, enterprise, team-growth, enterprise-growth, business-critical
    • subscriptionStatus string optional
      The Stripe subscription status (e.g. active, past_due, canceled), if applicable.
    • subscriptionTrialEnd integer optional
      The Unix timestamp when the subscription trial ends.
    • subscriptionCancelAtPeriodEnd boolean optional
      Whether the subscription will be canceled at the end of the current billing period.
    • subscriptionPeriodEnd string optional
      The time when the current subscription or license period ends. For SaaS subscriptions this is the Stripe billing period end. For self-hosted installations this is the license expiry date.
    • userRole enum required
      UserRole is the requesting user’s role in the organization.
      Values: none, member, admin, potential-member, stack-collaborator, billing-manager
    • defaultStackPermission enum required
      DefaultStackPermission is the default permission every member has for accessing the organization’s stacks.
      Values: 0, 101, 102, 103, 104
    • defaultEnvironmentPermission enum required
      DefaultEnvironmentPermission is the default permission every member has for accessing the organization’s environments.
      Values: none, read, open, write, admin
    • defaultAccountPermission enum required
      DefaultAccountPermission is the default permission every member has for accessing the organization’s insight accounts.
      Values: 0, 1, 2, 3
    • membersCanCreateStacks boolean required
      Whether organization members can create stacks.
    • membersCanDeleteStacks boolean required
      Whether organization members can delete stacks.
    • membersCanTransferStacks boolean required
      Whether organization members can transfer stacks.
    • membersCanCreateTeams boolean required
      Whether organization members can create teams.
    • membersCanCreateAccounts boolean required
      Whether organization members can create Insights accounts.
    • neoEnabled boolean required
      Whether Neo AI agent features are enabled for the organization.
    • neoApprovalMode enum required
      neoApprovalMode is the default approval mode for new Neo AI agent tasks.
      Values: manual, auto, balanced
    • neoTaskSharingMode enum required
      NeoTaskSharingMode is the task sharing mode for Neo AI agents in the organization.
      Values: none, org
    • insightsTrialEnd integer optional
      The Unix timestamp when the Insights trial ends.
    • insightsBillingAccepted boolean optional
      true if accepted, false if denied, nil if no action taken
    • insightsTrialUsingPolicy boolean required
      true if org needs to be upgraded to business critical
    • aiEnablement string required
      The AI feature enablement status for the organization (e.g. enabled, disabled, opt-in).
    • preferredVCS enum required
      The organization’s preferred VCS vendor.
      Values: none, bitbucket, github, gitlab
    • auditLogsEnabled boolean required
      Deprecated. Access the AuditLogsEnabled feature from the Features property.
    • webhooksEnabled boolean required
      Deprecated. Access the WebhooksEnabled feature from the Features property.
    • features OrganizationFeatures required
      The feature flags enabled for this organization, controlling access to specific functionality.
    • auditLogsEnabled boolean required
      Whether audit logs are enabled for the organization.
    • crossGuardEnabled boolean required
      Whether CrossGuard policy enforcement is enabled.
    • webhooksEnabled boolean required
      Whether webhooks are enabled for the organization.
    • integrationAssistantEnabled boolean required
      Whether the integration assistant is enabled.
    • aleEnabled boolean required
      Whether audit log export (ALE) is enabled.
    • deployEnabled boolean required
      Whether Pulumi Deployments is enabled.
    • scimEnabled boolean required
      Whether SCIM provisioning is enabled.
    • resourceSearchEnabled boolean required
      Whether resource search is enabled.
    • resourceExportEnabled boolean required
      Whether resource export is enabled.
    • propertySearchUIEnabled boolean required
      Whether the property search UI is enabled.
    • nlpSearchEnabled boolean required
      Whether natural language search is enabled.
    • customTemplatesEnabled boolean required
      Whether custom templates are enabled.
    • restoreStacksEnabled boolean required
      Whether restoring deleted stacks is enabled.
    • environmentsEnabled boolean required
      Whether Pulumi ESC environments are enabled.
    • environmentRevisionTagsEnabled boolean required
      Whether environment revision tags are enabled.
    • legacyDeploymentsOrgToken boolean required
      Whether the organization uses a legacy org token for deployments.
    • gitHubEnterpriseIntegrationEnabled boolean required
      Whether GitHub Enterprise integration is enabled.
    • agentPoolRegistrationEnabled boolean required
      Whether agent pool registration is enabled for self-hosted deployments.
    • dashboardOnboardingUIEnabled boolean required
      Whether the dashboard onboarding UI is enabled.
    • driftDetectionEnabled boolean required
      Whether drift detection is enabled.
    • selfHostedDeploymentsEnabled boolean required
      Whether self-hosted deployment agents are enabled.
    • auditLogUIFilteringEnabled boolean required
      Whether audit log UI filtering is enabled.
    • dependencyCachingEnabled boolean required
      Whether dependency caching for deployments is enabled.
    • environmentsRestoreEnabled boolean required
      Whether restoring deleted environments is enabled.
    • pangeaAccountsScanPageEnabled boolean required
      Whether the Pangea accounts scan page is enabled.
    • customRolesEnabled boolean required
      Whether custom RBAC roles are enabled.
    • environmentSecretRotationEnabled boolean required
      Whether environment secret rotation is enabled.
    • insightsMonetizationEnabled boolean required
      Whether Insights monetization features are enabled.
    • selfServeIDPRemoval boolean required
      Whether self-serve IDP removal is enabled.
    • iacCloudImportEnabled boolean required
      Whether IaC cloud import is enabled.
    • bringYourOwnKeyEnabled boolean required
      Whether bring-your-own-key encryption is enabled.
    • approvalsEnabled boolean required
      Whether change request approvals are enabled.
    • escOnboardingEnabled boolean required
      Whether ESC onboarding is enabled.
    • escOnboardingV2Enabled boolean required
      Whether ESC onboarding v2 is enabled.
    • escEditorRevampEnabled boolean required
      Whether the ESC editor revamp is enabled.
    • escOnboardingAzureOAuthClientEnabled boolean required
      Whether the Azure OAuth client for ESC onboarding is enabled.
    • escOnboardingGcpOAuthClientEnabled boolean required
      Whether the GCP OAuth client for ESC onboarding is enabled.
    • policyManagementV2Enabled boolean required
      Whether policy management v2 is enabled.
    • policyIssueManagementEnabled boolean required
      Whether policy issue management is enabled.
    • aiAgentsEnabled boolean required
      Whether AI agents (Pulumi Copilot) are enabled.
    • themingEnabled boolean required
      Whether UI theming is enabled.
    • customRoleCondition boolean required
      Whether custom role conditions are enabled.
    • neoTaskSharingEnabled boolean required
      Whether Copilot task sharing is enabled.
    • ghAppDetailedDiffEnabled boolean required
      Whether the GitHub App detailed diff view is enabled.
    • neoServerSideApprovalsEnabled boolean required
      Whether Neo server side approvals is enabled.
    • neoPlanModeEnabled boolean required
      Whether Neo plan mode is enabled.
    • getStartedOnboardEnabled boolean required
      Whether the getting started onboarding flow is enabled.
    • neoReadOnlyEnabled boolean required
      Whether Neo read-only permission mode is enabled.
    • discoveredStacksEnabled boolean required
      Whether discovered stacks are enabled.
    • agentIntegrationCatalogEnabled boolean required
      Whether the agent integration catalog is enabled.
    • aiReviewCodeAccessEnabled boolean required
      Whether AI review code access is enabled.
    • genericVCSEnabled boolean required
      Whether generic VCS integrations are enabled.
    • bitbucketVCSEnabled boolean required
      Whether Bitbucket VCS integration is enabled.
    • accountCount integer required
      AccountCount is the current number of Insights Accounts in the organization. (May be more than the requesting user has permission to see.)
    • environmentCount integer required
      EnvironmentCount is the current number of environments in the organization. (May be more than the requesting user has permission to see.)
    • stackCount integer required
      StackCount is the current number of stacks in the organization. (May be more than the requesting user has permission to see.)
    • maxStacks integer optional
      MaxStacks is the maximum number of stacks the organization can have based on its subscription. Will be nil/omitted if there is no limit.
    • memberCount integer required
      MemberCount is the number of members the organization has. Will be incorrect for organizations on the TeamPerStack subscription plan.
    • maxMembers integer optional
      MaxMembers is the maximum number of members the organization can have based on its subscription. (Only set for per-member billed orgs.)
    • locked enum optional
      Locked is non-nil if an organization is locked, indicating the specific reason why it was locked. (Which may determine which actions are available in the Console.)
      Values: bad-subscription, not-locked, read-only, rename-in-progress, transfer-in-progress
    • defaultRoleId string optional
      DefaultRoleID is the ID of the default role for new users added to the organization. If unset, defaults to the “Member” role.
    • defaultDeploymentRoleId string optional
      DefaultDeploymentRoleID is the ID of the default role used for deployments when no specific role is configured in the stack’s deployment settings. If unset, deployments run using the triggering user’s own permissions.