Policies
GetOrganizationPolicies
UpdateOrganizationPolicies
ModelsExpand Collapse
class AgentPolicy: …AgentPolicy contains agent-specific policy settings for an organization
AgentPolicy contains agent-specific policy settings for an organization
command_deny_list contains a list of commands that agents are not allowed to execute
scm_tools_disabled controls whether SCM (Source Control Management) tools are disabled for agents
conversation_sharing_policy: Optional[ConversationSharingPolicy]conversation_sharing_policy controls whether agent conversations can be shared
conversation_sharing_policy controls whether agent conversations can be shared
class CrowdStrikeConfig: …CrowdStrikeConfig configures CrowdStrike Falcon sensor deployment
CrowdStrikeConfig configures CrowdStrike Falcon sensor deployment
class CustomSecurityAgent: …CustomSecurityAgent defines a custom security agent configured by an organization admin.
CustomSecurityAgent defines a custom security agent configured by an organization admin.
class OrganizationPolicies: …
agent_policy contains agent-specific policy settings
agent_policy contains agent-specific policy settings
command_deny_list contains a list of commands that agents are not allowed to execute
scm_tools_disabled controls whether SCM (Source Control Management) tools are disabled for agents
conversation_sharing_policy: Optional[ConversationSharingPolicy]conversation_sharing_policy controls whether agent conversations can be shared
conversation_sharing_policy controls whether agent conversations can be shared
allowed_editor_ids is the list of editor IDs that are allowed to be used in the organization
allow_local_runners controls whether local runners are allowed to be used in the organization
default_editor_id is the default editor ID to be used when a user doesn’t specify one
default_environment_image is the default container image when none is defined in repo
disable_from_scratch controls whether non-admin users can create blank environments without a Git or URL initializer.
maximum_environments_per_user limits total environments (running or stopped) per user
maximum_running_environments_per_user limits simultaneously running environments per user
members_require_projects controls whether environments can only be created from projects by non-admin users
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.
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.
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.
web_browser_disabled controls whether users can open the built-in web browser from environment pages. This does not affect VS Code Browser.
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).
editor_version_restrictions: Optional[Dict[str, EditorVersionRestrictions]]editor_version_restrictions restricts which editor versions can be used.
Maps editor ID to version policy, editor_version_restrictions not set means no restrictions.
If empty or not set for an editor, we will use the latest version of the editor
editor_version_restrictions restricts which editor versions can be used. Maps editor ID to version policy, editor_version_restrictions not set means no restrictions. If empty or not set for an editor, we will use the latest version of the editor
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).
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')project_creation_defaults: Optional[ProjectCreationDefaults]project_creation_defaults contains default settings applied to newly created projects.
project_creation_defaults contains default settings applied to newly created projects.
environment_classes specifies default environment classes and their
per-class settings (order, prebuild, warm pool) for newly created projects.
Each entry must reference an existing, enabled, non-local-runner
environment class in the organization.
environment_classes specifies default environment classes and their per-class settings (order, prebuild, warm pool) for newly created projects. Each entry must reference an existing, enabled, non-local-runner environment class in the organization.
environment_class_id is the ID of the environment class.
prebuild controls whether prebuilds are enabled for this environment class on newly created projects.
warm_pool: Optional[ProjectCreationDefaultEnvironmentClassWarmPool]warm_pool configures the warm pool for this environment class on newly
created projects. Only meaningful when prebuild is true.
warm_pool configures the warm pool for this environment class on newly created projects. Only meaningful when prebuild is true.
insights_enabled controls whether Insights (co-author attribution) is automatically enabled on newly created projects.
prebuilds: Optional[ProjectCreationDefaultsPrebuilds]prebuilds configures default prebuild settings for newly created projects.
When set, prebuilds can be enabled per environment class via the
environment_classes entries. When absent, prebuilds are not enabled by default.
prebuilds configures default prebuild settings for newly created projects. When set, prebuilds can be enabled per environment class via the environment_classes entries. When absent, prebuilds are not enabled by default.
enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds on newly created projects.
prebuild_executor: Optional[Subject]prebuild_executor is the service account used to run prebuilds on newly
created projects. Must be a service account (not a user).
prebuild_executor is the service account used to run prebuilds on newly created projects. Must be a service account (not a user).
timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours.
security_agent_policy: Optional[SecurityAgentPolicy]security_agent_policy contains security agent configuration for the organization.
When configured, security agents are automatically deployed to all environments.
security_agent_policy contains security agent configuration for the organization. When configured, security agents are automatically deployed to all environments.
crowdstrike: Optional[CrowdStrikeConfig]crowdstrike contains CrowdStrike Falcon configuration
crowdstrike contains CrowdStrike Falcon configuration
class ProjectCreationDefaultEnvironmentClass: …ProjectCreationDefaultEnvironmentClass configures a single environment class
in the project creation defaults.
ProjectCreationDefaultEnvironmentClass configures a single environment class in the project creation defaults.
environment_class_id is the ID of the environment class.
prebuild controls whether prebuilds are enabled for this environment class on newly created projects.
warm_pool: Optional[ProjectCreationDefaultEnvironmentClassWarmPool]warm_pool configures the warm pool for this environment class on newly
created projects. Only meaningful when prebuild is true.
warm_pool configures the warm pool for this environment class on newly created projects. Only meaningful when prebuild is true.
class ProjectCreationDefaultEnvironmentClassWarmPool: …ProjectCreationDefaultEnvironmentClassWarmPool configures warm pool defaults
for an environment class in the project creation defaults.
ProjectCreationDefaultEnvironmentClassWarmPool configures warm pool defaults for an environment class in the project creation defaults.
class ProjectCreationDefaults: …ProjectCreationDefaults contains default settings applied to newly created projects.
ProjectCreationDefaults contains default settings applied to newly created projects.
environment_classes specifies default environment classes and their
per-class settings (order, prebuild, warm pool) for newly created projects.
Each entry must reference an existing, enabled, non-local-runner
environment class in the organization.
environment_classes specifies default environment classes and their per-class settings (order, prebuild, warm pool) for newly created projects. Each entry must reference an existing, enabled, non-local-runner environment class in the organization.
environment_class_id is the ID of the environment class.
prebuild controls whether prebuilds are enabled for this environment class on newly created projects.
warm_pool: Optional[ProjectCreationDefaultEnvironmentClassWarmPool]warm_pool configures the warm pool for this environment class on newly
created projects. Only meaningful when prebuild is true.
warm_pool configures the warm pool for this environment class on newly created projects. Only meaningful when prebuild is true.
insights_enabled controls whether Insights (co-author attribution) is automatically enabled on newly created projects.
prebuilds: Optional[ProjectCreationDefaultsPrebuilds]prebuilds configures default prebuild settings for newly created projects.
When set, prebuilds can be enabled per environment class via the
environment_classes entries. When absent, prebuilds are not enabled by default.
prebuilds configures default prebuild settings for newly created projects. When set, prebuilds can be enabled per environment class via the environment_classes entries. When absent, prebuilds are not enabled by default.
enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds on newly created projects.
prebuild_executor: Optional[Subject]prebuild_executor is the service account used to run prebuilds on newly
created projects. Must be a service account (not a user).
prebuild_executor is the service account used to run prebuilds on newly created projects. Must be a service account (not a user).
timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours.
class ProjectCreationDefaultsPrebuilds: …ProjectCreationDefaultsPrebuilds configures default prebuild settings.
Presence of this message means prebuilds can be enabled for the default environment classes.
ProjectCreationDefaultsPrebuilds configures default prebuild settings. Presence of this message means prebuilds can be enabled for the default environment classes.
enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds on newly created projects.
prebuild_executor: Optional[Subject]prebuild_executor is the service account used to run prebuilds on newly
created projects. Must be a service account (not a user).
prebuild_executor is the service account used to run prebuilds on newly created projects. Must be a service account (not a user).
timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours.
class SecurityAgentPolicy: …SecurityAgentPolicy contains security agent configuration for an organization.
When enabled, security agents are automatically deployed to all environments.
SecurityAgentPolicy contains security agent configuration for an organization. When enabled, security agents are automatically deployed to all environments.
crowdstrike: Optional[CrowdStrikeConfig]crowdstrike contains CrowdStrike Falcon configuration
crowdstrike contains CrowdStrike Falcon configuration
class PolicyRetrieveResponse: …
agent_policy contains agent-specific policy settings
agent_policy contains agent-specific policy settings
command_deny_list contains a list of commands that agents are not allowed to execute
scm_tools_disabled controls whether SCM (Source Control Management) tools are disabled for agents
conversation_sharing_policy: Optional[ConversationSharingPolicy]conversation_sharing_policy controls whether agent conversations can be shared
conversation_sharing_policy controls whether agent conversations can be shared
allowed_editor_ids is the list of editor IDs that are allowed to be used in the organization
allow_local_runners controls whether local runners are allowed to be used in the organization
default_editor_id is the default editor ID to be used when a user doesn’t specify one
default_environment_image is the default container image when none is defined in repo
disable_from_scratch controls whether non-admin users can create blank environments without a Git or URL initializer.
maximum_environments_per_user limits total environments (running or stopped) per user
maximum_running_environments_per_user limits simultaneously running environments per user
members_require_projects controls whether environments can only be created from projects by non-admin users
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.
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.
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.
web_browser_disabled controls whether users can open the built-in web browser from environment pages. This does not affect VS Code Browser.
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).
editor_version_restrictions: Optional[Dict[str, EditorVersionRestrictions]]editor_version_restrictions restricts which editor versions can be used.
Maps editor ID to version policy, editor_version_restrictions not set means no restrictions.
If empty or not set for an editor, we will use the latest version of the editor
editor_version_restrictions restricts which editor versions can be used. Maps editor ID to version policy, editor_version_restrictions not set means no restrictions. If empty or not set for an editor, we will use the latest version of the editor
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).
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')project_creation_defaults: Optional[ProjectCreationDefaults]project_creation_defaults contains default settings applied to newly created projects.
project_creation_defaults contains default settings applied to newly created projects.
environment_classes specifies default environment classes and their
per-class settings (order, prebuild, warm pool) for newly created projects.
Each entry must reference an existing, enabled, non-local-runner
environment class in the organization.
environment_classes specifies default environment classes and their per-class settings (order, prebuild, warm pool) for newly created projects. Each entry must reference an existing, enabled, non-local-runner environment class in the organization.
environment_class_id is the ID of the environment class.
prebuild controls whether prebuilds are enabled for this environment class on newly created projects.
warm_pool: Optional[ProjectCreationDefaultEnvironmentClassWarmPool]warm_pool configures the warm pool for this environment class on newly
created projects. Only meaningful when prebuild is true.
warm_pool configures the warm pool for this environment class on newly created projects. Only meaningful when prebuild is true.
insights_enabled controls whether Insights (co-author attribution) is automatically enabled on newly created projects.
prebuilds: Optional[ProjectCreationDefaultsPrebuilds]prebuilds configures default prebuild settings for newly created projects.
When set, prebuilds can be enabled per environment class via the
environment_classes entries. When absent, prebuilds are not enabled by default.
prebuilds configures default prebuild settings for newly created projects. When set, prebuilds can be enabled per environment class via the environment_classes entries. When absent, prebuilds are not enabled by default.
enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds on newly created projects.
prebuild_executor: Optional[Subject]prebuild_executor is the service account used to run prebuilds on newly
created projects. Must be a service account (not a user).
prebuild_executor is the service account used to run prebuilds on newly created projects. Must be a service account (not a user).
timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours.
security_agent_policy: Optional[SecurityAgentPolicy]security_agent_policy contains security agent configuration for the organization.
When configured, security agents are automatically deployed to all environments.
security_agent_policy contains security agent configuration for the organization. When configured, security agents are automatically deployed to all environments.
crowdstrike: Optional[CrowdStrikeConfig]crowdstrike contains CrowdStrike Falcon configuration
crowdstrike contains CrowdStrike Falcon configuration