Organizations

GetOrganizationMetadata

GetOrganizationMetadata returns metadata about the given organization. This is designed to be an inexpensive call.

get/api/orgs/{orgName}/metadata

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/orgs/{orgName}/metadata
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

Response

OK

accountCountinteger required

AccountCount is the current number of Insights Accounts in the organization. (May be more than the requesting user has permission to see.)

aiEnablementstring required

The AI feature enablement status for the organization (e.g. enabled, disabled, opt-in).

auditLogsEnabledboolean required

Deprecated. Access the AuditLogsEnabled feature from the Features property.

backingOrgLoginstring

The login name of the backing organization on the identity provider.

createdstring date-time required

The time the organization was created.

defaultAccountPermission0 | 1 | 2 | 3 required

DefaultAccountPermission is the default permission every member has for accessing the organization's insight accounts.

defaultDeploymentRoleIdstring

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.

defaultEnvironmentPermission'none' | 'read' | 'open' | 'write' | 'admin' required

DefaultEnvironmentPermission is the default permission every member has for accessing the organization's environments.

defaultRoleIdstring

DefaultRoleID is the ID of the default role for new users added to the organization. If unset, defaults to the "Member" role.

defaultStackPermission0 | 101 | 102 | 103 | 104 required

DefaultStackPermission is the default permission every member has for accessing the organization's stacks.

environmentCountinteger required

EnvironmentCount is the current number of environments in the organization. (May be more than the requesting user has permission to see.)

idstring required

The unique identifier of the organization.

insightsBillingAcceptedboolean

true if accepted, false if denied, nil if no action taken

insightsTrialEndinteger

The Unix timestamp when the Insights trial ends.

insightsTrialUsingPolicyboolean required

true if org needs to be upgraded to business critical

kind'single-user' | 'bitbucket' | 'github' | 'gitlab' | 'pulumi' | 'saml' required

The kind of backing identity provider for the organization.

locked'bad-subscription' | 'not-locked' | 'read-only' | 'rename-in-progress' | 'transfer-in-progress'

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.)

maxAccessTokenExpiryDaysinteger

The maximum allowed access token expiry, in days, for personal, organization, and team access tokens used against this organization. Null means no policy (the default behavior, in which tokens may have any expiry or no expiry). When set, requires every token to have an expiry, and the token's total lifetime (from creation to expiry) must not exceed this many days. Web sessions and system-managed tokens are not subject to this policy.

maxMembersinteger

MaxMembers is the maximum number of members the organization can have based on its subscription. (Only set for per-member billed orgs.)

maxStacksinteger

MaxStacks is the maximum number of stacks the organization can have based on its subscription. Will be nil/omitted if there is no limit.

memberCountinteger required

MemberCount is the number of members the organization has. Will be incorrect for organizations on the TeamPerStack subscription plan.

membersCanCreateAccountsboolean required

Whether organization members can create Insights accounts.

membersCanCreateStacksboolean required

Whether organization members can create stacks.

membersCanCreateTeamsboolean required

Whether organization members can create teams.

membersCanDeleteStacksboolean required

Whether organization members can delete stacks.

membersCanTransferStacksboolean required

Whether organization members can transfer stacks.

naturalLanguageSearchDisabledboolean required

Whether natural-language resource search is disabled for the organization. Independent of neoEnabled; if neoEnabled is false, this flag has no additional effect.

neoAgentDisabledboolean required

Whether the Neo agent is disabled for the organization. Independent of neoEnabled; if neoEnabled is false, this flag has no additional effect.

neoApprovalMode'manual' | 'auto' | 'balanced' required

neoApprovalMode is the default approval mode for new Neo AI agent tasks.

neoCLIExplanationsDisabledboolean required

Whether Neo CLI explanations (preview and update-failure explanations served to the CLI) are disabled for the organization. Independent of neoEnabled; if neoEnabled is false, this flag has no additional effect.

neoEnabledboolean required

Whether Neo AI agent features are enabled for the organization.

neoTaskSharingMode'none' | 'org' required

NeoTaskSharingMode is the task sharing mode for Neo AI agents in the organization.

pastDueSincestring date-time

The time when the subscription entered past-due status, if applicable. Present only when the subscription is past due and the auto-lock grace period is active.

preferredVCS'none' | 'bitbucket' | 'github' | 'gitlab' required

The organization's preferred VCS vendor.

product'team-per-stack' | 'community' | 'individual' | 'team-starter' | 'team-pro' | 'enterprise' | 'team-growth' | 'enterprise-growth' | 'business-critical' | 'free' | 'essentials' | 'pro' | 'business-enterprise'

Subscription-related information if the organization has a Pulumi subscription. Otherwise, assume it is a grandfathered TeamPerStack org or in the Community Edition.

retrialExpirationstring date-time

The time when the organization's active retrial expires, if it is on a retrial.

retrialProduct'team-per-stack' | 'community' | 'individual' | 'team-starter' | 'team-pro' | 'enterprise' | 'team-growth' | 'enterprise-growth' | 'business-critical' | 'free' | 'essentials' | 'pro' | 'business-enterprise'

The plan whose features the organization's active retrial grants, if it is on a retrial. The product field keeps reporting the plan the organization is subscribed to.

stackCountinteger required

StackCount is the current number of stacks in the organization. (May be more than the requesting user has permission to see.)

subscriptionCancelAtPeriodEndboolean

Whether the subscription will be canceled at the end of the current billing period.

subscriptionPeriodEndstring date-time

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.

subscriptionStatusstring

The Stripe subscription status (e.g. active, past_due, canceled), if applicable.

subscriptionTrialEndinteger

The Unix timestamp when the subscription trial ends.

userRole'none' | 'member' | 'admin' | 'potential-member' | 'stack-collaborator' | 'billing-manager' required

UserRole is the requesting user's role in the organization.

webhooksEnabledboolean required

Deprecated. Access the WebhooksEnabled feature from the Features property.

Changes

No recorded changes to this operation across all 1 revision of this API.