Atlassian: Get project policy state

Atlassian policies.getPolicyState: arguments, response, policy and SDK examples.

Operation atlassian.getpolicystate

Provider route: GET /{cloudId}/rest/api/3/policies/project/{projectIdOrKey}. 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"]["getPolicyState"]>[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.getPolicyState(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.get_policy_state(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.projectIdOrKey`	string	Required within parent

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
`$`	array	Root
`$[]`	Model	Each item	Expand Get project policy state — response body — item

Referenced models: Get project policy state — response body — item

Schemas

Get project policy state — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative
`id (anyOf 2)`	null	Alternative
`isDefault`	JSON	Optional
`isDefault (anyOf 1)`	boolean	Alternative
`isDefault (anyOf 2)`	null	Alternative
`policyDescription`	JSON	Optional
`policyDescription (anyOf 1)`	string	Alternative
`policyDescription (anyOf 2)`	null	Alternative
`policyName`	JSON	Optional
`policyName (anyOf 1)`	string	Alternative
`policyName (anyOf 2)`	null	Alternative
`rulesByDomain`	JSON	Optional
`rulesByDomain (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`rulesByDomain (anyOf 1).*`	array	Additional keys
`rulesByDomain (anyOf 1).*[]`	Model	Each item	Expand Get project policy rules — response body — item
`rulesByDomain (anyOf 2)`	null	Alternative
`version`	JSON	Optional
`version (anyOf 1)`	JSON	Alternative
`version (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`version (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`version (anyOf 2)`	null	Alternative

Referenced models: Get project policy rules — response body — item

Get project policy rules — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`domain`	JSON	Optional
`domain (anyOf 1)`	string	Alternative
`domain (anyOf 2)`	null	Alternative
`properties`	JSON	Optional
`properties (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`properties (anyOf 1).*`	JSON	Additional keys
`properties (anyOf 2)`	null	Alternative
`ruleId`	JSON	Optional
`ruleId (anyOf 1)`	string	Alternative
`ruleId (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.getpolicystate. Catalog operation: getpolicystate. 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-project"]

Official provider source

Report an issue with this page