Atlassian: Remove a policy from projects

← Policies operations · Get started

Operation atlassian.removepolicyfromprojects

Provider route: POST /{cloudId}/rest/api/3/policies/{policyId}/remove. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["policies"]["removePolicyFromProjects"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.policies.removePolicyFromProjects(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.policies.remove_policy_from_projects(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
path.policyId	string	Required within parent
body	Model	Required within parent	Expand Apply a policy to projects — request body — body

Referenced models: Apply a policy to projects — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Apply a policy to projects — response body

Referenced models: Apply a policy to projects — response body

Schemas

Apply a policy to projects — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
projectIds	array	Optional
projectIds[]	integer	Each item	Format: int64

Apply a policy to projects — response body

Field	Type	Presence	Description and constraints
$	object	Root
failed	JSON	Optional
failed (anyOf 1)	array	Alternative
failed (anyOf 1)[]	Model	Each item	Expand Apply a policy to projects — response body — failed array item
failed (anyOf 2)	null	Alternative
successful	JSON	Optional
successful (anyOf 1)	array	Alternative
successful (anyOf 1)[]	Model	Each item	Expand Apply a policy to projects — response body — failed array item
successful (anyOf 2)	null	Alternative

Referenced models: Apply a policy to projects — response body — failed array item

Apply a policy to projects — response body — failed array item

Field	Type	Presence	Description and constraints
$	object	Root
errors	JSON	Optional
errors (anyOf 1)	array	Alternative
errors (anyOf 1)[]	Model	Each item	Expand Apply a policy to projects — response body — failed array item errors array item
errors (anyOf 2)	null	Alternative
message	JSON	Optional
message (anyOf 1)	string	Alternative
message (anyOf 2)	null	Alternative
projectId	JSON	Optional
projectId (anyOf 1)	JSON	Alternative
projectId (anyOf 1) (anyOf 1)	integer	Alternative	Format: int64
projectId (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
projectId (anyOf 2)	null	Alternative

Referenced models: Apply a policy to projects — response body — failed array item errors array item

Apply a policy to projects — response body — failed array item errors array item

Field	Type	Presence	Description and constraints
$	object	Root
entityId	JSON	Optional
entityId (anyOf 1)	string	Alternative
entityId (anyOf 2)	null	Alternative
entityName	JSON	Optional
entityName (anyOf 1)	string	Alternative
entityName (anyOf 2)	null	Alternative
entityType	JSON	Optional
entityType (anyOf 1)	string	Alternative
entityType (anyOf 2)	null	Alternative
remediationHint	JSON	Optional
remediationHint (anyOf 1)	string	Alternative
remediationHint (anyOf 2)	null	Alternative
ruleTypeId	JSON	Optional
ruleTypeId (anyOf 1)	string	Alternative
ruleTypeId (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.removepolicyfromprojects. Catalog operation: removepolicyfromprojects. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["manage:jira-configuration"]

Official provider source