UpdateOrganizationPolicies

client.organizations.policies.update(, ?): PolicyUpdateResponse

POST/gitpod.v1.OrganizationService/UpdateOrganizationPolicies

Updates organization policy settings.

Use this method to:

Configure editor restrictions
Set environment resource limits
Define project creation permissions
Customize default configurations

Examples

Update editor policies:

Restricts available editors and sets a default.

organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
allowedEditorIds:
  - "vscode"
  - "jetbrains"
defaultEditorId: "vscode"

Set environment limits:

Configures limits for environment usage.

organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
maximumEnvironmentTimeout: "3600s"
maximumRunningEnvironmentsPerUser: "5"
maximumEnvironmentsPerUser: "20"

ParametersExpand Collapse

body: PolicyUpdateParams { organizationId, agentPolicy, allowedEditorIds, 20 more }

organizationId: string

organization_id is the ID of the organization to update policies for

formatuuid

agentPolicy?: AgentPolicy | null

agent_policy contains agent-specific policy settings

allowedAgentIds?: Array<string>

allowed_agent_ids contains the agent IDs users may select when the codex_rollout feature flag is enabled. Empty means all agents are allowed.

DeprecatedallowedCodexModels?: Array<CodexOpenAIModel>

Deprecated: use codex_model_policy. This legacy allowlist cannot distinguish omitted from intentionally empty on update requests. Empty means all Codex models are allowed.

One of the following:

"CODEX_OPEN_AI_MODEL_UNSPECIFIED"

"CODEX_OPEN_AI_MODEL_GPT_5_5"

"CODEX_OPEN_AI_MODEL_GPT_5_4"

"CODEX_OPEN_AI_MODEL_GPT_5_4_MINI"

"CODEX_OPEN_AI_MODEL_GPT_5_3_CODEX"

"CODEX_OPEN_AI_MODEL_GPT_5_3_CODEX_SPARK"

"CODEX_OPEN_AI_MODEL_GPT_5_2"

"CODEX_OPEN_AI_MODEL_GPT_5_6_SOL"

"CODEX_OPEN_AI_MODEL_GPT_5_6_TERRA"

"CODEX_OPEN_AI_MODEL_GPT_5_6_LUNA"

allowedCodexReasoningEfforts?: Array<CodexReasoningEffort>

allowed_codex_reasoning_efforts contains the Codex reasoning efforts users may select when the codex_rollout feature flag is enabled. Empty means all Codex reasoning efforts are allowed.

One of the following:

"CODEX_REASONING_EFFORT_UNSPECIFIED"

"CODEX_REASONING_EFFORT_LOW"

"CODEX_REASONING_EFFORT_MEDIUM"

"CODEX_REASONING_EFFORT_HIGH"

"CODEX_REASONING_EFFORT_EXTRA_HIGH"

allowedCodexServiceTiers?: Array<CodexServiceTier>

allowed_codex_service_tiers contains the Codex service tiers users may select when the codex_rollout feature flag is enabled. Empty means all Codex service tiers are allowed.

One of the following:

"CODEX_SERVICE_TIER_UNSPECIFIED"

"CODEX_SERVICE_TIER_FAST"

codexModelPolicy?: CodexModelPolicy { modelStates }

codex_model_policy contains explicit per-model Codex availability states. Omit to leave the current model policy unchanged. Send an empty policy to clear explicit model states.

modelStates?: Record<string, "CODEX_MODEL_POLICY_STATE_UNSPECIFIED" | "CODEX_MODEL_POLICY_STATE_ALLOWED" | "CODEX_MODEL_POLICY_STATE_DISABLED">

model_states maps CodexOpenAIModel enum names to explicit policy states. Missing entries are treated as allowed.

One of the following:

"CODEX_MODEL_POLICY_STATE_UNSPECIFIED"

"CODEX_MODEL_POLICY_STATE_ALLOWED"

"CODEX_MODEL_POLICY_STATE_DISABLED"

commandDenyList?: Array<string>

command_deny_list contains a list of commands that agents are not allowed to execute

conversationSharingPolicy?: ConversationSharingPolicy | null

conversation_sharing_policy controls whether agent conversations can be shared

One of the following:

"CONVERSATION_SHARING_POLICY_UNSPECIFIED"

"CONVERSATION_SHARING_POLICY_DISABLED"

"CONVERSATION_SHARING_POLICY_ORGANIZATION"

maxSubagentsPerEnvironment?: number | null

max_subagents_per_environment limits the number of non-terminal sub-agents a parent can have running simultaneously in the same environment. Valid range: 0-10. Zero means use the default (5).

formatint32

maximum10

mcpDisabled?: boolean | null

mcp_disabled controls whether MCP (Model Context Protocol) is disabled for agents

scmToolsAllowedGroupId?: string | null

scm_tools_allowed_group_id restricts SCM tools access to members of this group. Empty means no restriction (all users can use SCM tools if not disabled).

scmToolsDisabled?: boolean | null

scm_tools_disabled controls whether SCM (Source Control Management) tools are disabled for agents

allowedEditorIds?: Array<string>

allowed_editor_ids is the list of editor IDs that are allowed to be used in the organization

allowLocalRunners?: boolean | null

allow_local_runners controls whether local runners are allowed to be used in the organization

defaultEditorId?: string | null

default_editor_id is the default editor ID to be used when a user doesn’t specify one

defaultEnvironmentImage?: string | null

default_environment_image is the default container image when none is defined in repo

deleteArchivedEnvironmentsAfter?: string | null

delete_archived_environments_after controls how long archived environments are kept before automatic deletion. 0 means no automatic deletion. Maximum duration is 4 weeks (2419200 seconds).

formatregex

disableFromScratch?: boolean | null

disable_from_scratch controls whether non-admin users can create blank environments without a Git or URL initializer.

editorVersionRestrictions?: Record<string, EditorVersionRestrictions>

editor_version_restrictions restricts which editor versions can be used. Maps editor ID to version policy with allowed major versions.

allowedVersions?: Array<string>

allowed_versions lists the versions that are allowed If empty, we will use the latest version of the editor

Examples for JetBrains: ["2025.2", "2025.1", "2024.3"]

maximumEnvironmentLifetime?: string | null

maximum_environment_lifetime controls for how long environments are allowed to be reused. 0 means no maximum lifetime. Maximum duration is 180 days (15552000 seconds).

formatregex

maximumEnvironmentsPerUser?: string | null

maximum_environments_per_user limits total environments (running or stopped) per user

maximumEnvironmentTimeout?: string | null

maximum_environment_timeout controls the maximum timeout allowed for environments in seconds. 0 means no limit (never). Minimum duration is 30 minutes (1800 seconds). value must be 0s (no limit) or at least 1800s (30 minutes):

this == duration('0s') || this >= duration('1800s')

formatregex

maximumRunningEnvironmentsPerUser?: string | null

maximum_running_environments_per_user limits simultaneously running environments per user

maxPortAdmissionLevel?: AdmissionLevel | null

max_port_admission_level caps the maximum admission level a user-opened port may use. UNSPECIFIED means no cap (any AdmissionLevel value is allowed). System ports (VS Code Browser, agents) are exempt. The legacy port_sharing_disabled field, when true, takes precedence and blocks all user-initiated port sharing.

One of the following:

"ADMISSION_LEVEL_UNSPECIFIED"

"ADMISSION_LEVEL_OWNER_ONLY"

"ADMISSION_LEVEL_EVERYONE"

"ADMISSION_LEVEL_ORGANIZATION"

"ADMISSION_LEVEL_CREATOR_ONLY"

membersCreateProjects?: boolean | null

members_create_projects controls whether members can create projects

membersRequireProjects?: boolean | null

members_require_projects controls whether environments can only be created from projects by non-admin users

portSharingDisabled?: boolean | null

port_sharing_disabled controls whether user-initiated port sharing is disabled in the organization. System ports (VS Code Browser, agents) are always exempt from this policy.

requireCustomDomainAccess?: boolean | null

require_custom_domain_access controls whether users must access via custom domain when one is configured. When true, access via app.gitpod.io is blocked.

restrictAccountCreationToScim?: boolean | null

restrict_account_creation_to_scim controls whether account creation is restricted to SCIM-provisioned users only. When true and SCIM is configured for the organization, only users provisioned via SCIM can create accounts.

securityAgentPolicy?: SecurityAgentPolicy | null

security_agent_policy contains security agent configuration updates

crowdstrike?: Crowdstrike | null

crowdstrike contains CrowdStrike Falcon configuration updates

additionalOptions?: Record<string, string>

additional_options contains additional FALCONCTL_OPT_* options as key-value pairs

cidSecretId?: string | null

cid_secret_id references an organization secret containing the Customer ID (CID)

formatuuid

enabled?: boolean | null

enabled controls whether CrowdStrike Falcon is deployed to environments

image?: string | null

image is the CrowdStrike Falcon sensor container image reference

tags?: string | null

tags are optional tags to apply to the Falcon sensor

securityPolicyId?: string | null

security_policy_id assigns a Veto Exec SecurityPolicy to newly created environments. The public GA contract accepts policies that use only SecurityPolicy.Spec.executables. Assignment validates materializability and rejects unsupported executable selectors or effects. Set this field to an empty string to clear the default assignment.

formatuuid

vetoExecPolicy?: VetoExecPolicy { action, enabled, executables } | null

veto_exec_policy contains the veto exec policy for environments.

action?: KernelControlsAction

action specifies what action kernel-level controls take on policy violations

One of the following:

"KERNEL_CONTROLS_ACTION_UNSPECIFIED"

"KERNEL_CONTROLS_ACTION_BLOCK"

"KERNEL_CONTROLS_ACTION_AUDIT"

enabled?: boolean

enabled controls whether executable blocking is active

executables?: Array<string>

executables is the list of executable paths or names to block

webBrowserDisabled?: boolean | null

web_browser_disabled controls whether users can open the built-in web browser from environment pages. This does not affect VS Code Browser.

ReturnsExpand Collapse

PolicyUpdateResponse = unknown

UpdateOrganizationPolicies

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const policy = await client.organizations.policies.update({
  organizationId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047',
  maximumEnvironmentsPerUser: '20',
  maximumEnvironmentTimeout: '3600s',
  maximumRunningEnvironmentsPerUser: '5',
});

console.log(policy);

{}

Returns Examples

{}