## GetOrganizationPolicies **post** `/gitpod.v1.OrganizationService/GetOrganizationPolicies` Gets organization policy settings by organization ID. Use this method to: - Retrieve current policy settings for an organization - View resource limits and restrictions - Check allowed editors and other configurations ### Examples - Get organization policies: Retrieves policy settings for a specific organization. ```yaml organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" ``` ### Body Parameters - `organizationId: string` organization_id is the ID of the organization to retrieve policies for ### Returns - `policies: OrganizationPolicies` - `agentPolicy: AgentPolicy` agent_policy contains agent-specific policy settings - `commandDenyList: array of string` command_deny_list contains a list of commands that agents are not allowed to execute - `mcpDisabled: boolean` mcp_disabled controls whether MCP (Model Context Protocol) is disabled for agents - `scmToolsDisabled: boolean` scm_tools_disabled controls whether SCM (Source Control Management) tools are disabled for agents - `conversationSharingPolicy: optional ConversationSharingPolicy` conversation_sharing_policy controls whether agent conversations can be shared - `"CONVERSATION_SHARING_POLICY_UNSPECIFIED"` - `"CONVERSATION_SHARING_POLICY_DISABLED"` - `"CONVERSATION_SHARING_POLICY_ORGANIZATION"` - `maxSubagentsPerEnvironment: optional number` 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). - `scmToolsAllowedGroupId: optional string` 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). - `allowedEditorIds: array of string` allowed_editor_ids is the list of editor IDs that are allowed to be used in the organization - `allowLocalRunners: boolean` allow_local_runners controls whether local runners are allowed to be used in the organization - `defaultEditorId: string` default_editor_id is the default editor ID to be used when a user doesn't specify one - `defaultEnvironmentImage: string` default_environment_image is the default container image when none is defined in repo - `maximumEnvironmentsPerUser: string` maximum_environments_per_user limits total environments (running or stopped) per user - `maximumRunningEnvironmentsPerUser: string` maximum_running_environments_per_user limits simultaneously running environments per user - `membersCreateProjects: boolean` members_create_projects controls whether members can create projects - `membersRequireProjects: boolean` members_require_projects controls whether environments can only be created from projects by non-admin users - `organizationId: string` organization_id is the ID of the organization - `portSharingDisabled: boolean` 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` 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` 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. - `deleteArchivedEnvironmentsAfter: optional string` 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). - `editorVersionRestrictions: optional map[object { allowedVersions } ]` 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 - `allowedVersions: optional array of 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: optional string` 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). - `maximumEnvironmentTimeout: optional string` 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') ``` - `securityAgentPolicy: optional SecurityAgentPolicy` 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 - `additionalOptions: optional map[string]` additional_options contains additional FALCONCTL_OPT_* options as key-value pairs. Keys should NOT include the FALCONCTL_OPT_ prefix. - `cidSecretId: optional string` cid_secret_id references an organization secret containing the Customer ID (CID). - `enabled: optional boolean` enabled controls whether CrowdStrike Falcon is deployed to environments - `image: optional string` image is the CrowdStrike Falcon sensor container image reference - `tags: optional string` tags are optional tags to apply to the Falcon sensor (comma-separated) - `vetoExecPolicy: optional VetoExecPolicy` veto_exec_policy contains the veto exec policy for environments. - `action: optional KernelControlsAction` action specifies what action kernel-level controls take on policy violations - `"KERNEL_CONTROLS_ACTION_UNSPECIFIED"` - `"KERNEL_CONTROLS_ACTION_BLOCK"` - `"KERNEL_CONTROLS_ACTION_AUDIT"` - `enabled: optional boolean` enabled controls whether executable blocking is active - `executables: optional array of string` executables is the list of executable paths or names to block ### Example ```http curl https://app.gitpod.io/api/gitpod.v1.OrganizationService/GetOrganizationPolicies \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $GITPOD_API_KEY" \ -d '{ "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047" }' ``` #### Response ```json { "policies": { "agentPolicy": { "commandDenyList": [ "string" ], "mcpDisabled": true, "scmToolsDisabled": true, "conversationSharingPolicy": "CONVERSATION_SHARING_POLICY_UNSPECIFIED", "maxSubagentsPerEnvironment": 10, "scmToolsAllowedGroupId": "scmToolsAllowedGroupId" }, "allowedEditorIds": [ "string" ], "allowLocalRunners": true, "defaultEditorId": "defaultEditorId", "defaultEnvironmentImage": "defaultEnvironmentImage", "maximumEnvironmentsPerUser": "maximumEnvironmentsPerUser", "maximumRunningEnvironmentsPerUser": "maximumRunningEnvironmentsPerUser", "membersCreateProjects": true, "membersRequireProjects": true, "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "portSharingDisabled": true, "requireCustomDomainAccess": true, "restrictAccountCreationToScim": true, "deleteArchivedEnvironmentsAfter": "+9125115.360s", "editorVersionRestrictions": { "foo": { "allowedVersions": [ "string" ] } }, "maximumEnvironmentLifetime": "+9125115.360s", "maximumEnvironmentLifetimeStrict": true, "maximumEnvironmentTimeout": "+9125115.360s", "securityAgentPolicy": { "crowdstrike": { "additionalOptions": { "foo": "string" }, "cidSecretId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "enabled": true, "image": "image", "tags": "tags" }, "customAgents": [ { "id": "id", "description": "description", "enabled": true, "envMappings": [ { "name": "name", "secretName": "secretName" } ], "name": "name", "startCommand": "startCommand" } ] }, "vetoExecPolicy": { "action": "KERNEL_CONTROLS_ACTION_UNSPECIFIED", "enabled": true, "executables": [ "string" ], "safelist": [ "string" ] } } } ```