Atlassian: Get global settings

Atlassian jiraSettings.getConfiguration: arguments, response, policy and SDK examples.

← Jira settings operations · Get started

Operation atlassian.getconfiguration

Provider route: GET /{cloudId}/rest/api/3/configuration. 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["jiraSettings"]["getConfiguration"]>[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.jiraSettings.getConfiguration(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.jira_settings.get_configuration(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}$

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 Get global settings — response body

Referenced models: Get global settings — response body

Schemas

Get global settings — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about the configuration of Jira.
`attachmentsEnabled`	JSON	Optional
`attachmentsEnabled (anyOf 1)`	boolean	Alternative	Whether the ability to add attachments to issues is enabled. Read only: true
`attachmentsEnabled (anyOf 2)`	null	Alternative
`issueLinkingEnabled`	JSON	Optional
`issueLinkingEnabled (anyOf 1)`	boolean	Alternative	Whether the ability to link issues is enabled. Read only: true
`issueLinkingEnabled (anyOf 2)`	null	Alternative
`subTasksEnabled`	JSON	Optional
`subTasksEnabled (anyOf 1)`	boolean	Alternative	Whether the ability to create subtasks for issues is enabled. Read only: true
`subTasksEnabled (anyOf 2)`	null	Alternative
`timeTrackingConfiguration`	JSON	Optional
`timeTrackingConfiguration (anyOf 1)`	Model	Alternative	Expand Get time tracking settings — response body The configuration of time tracking. Read only: true
`timeTrackingConfiguration (anyOf 2)`	null	Alternative
`timeTrackingEnabled`	JSON	Optional
`timeTrackingEnabled (anyOf 1)`	boolean	Alternative	Whether the ability to track time is enabled. This property is deprecated. Read only: true
`timeTrackingEnabled (anyOf 2)`	null	Alternative
`unassignedIssuesAllowed`	JSON	Optional
`unassignedIssuesAllowed (anyOf 1)`	boolean	Alternative	Whether the ability to create unassigned issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details. Read only: true
`unassignedIssuesAllowed (anyOf 2)`	null	Alternative
`votingEnabled`	JSON	Optional
`votingEnabled (anyOf 1)`	boolean	Alternative	Whether the ability for users to vote on issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details. Read only: true
`votingEnabled (anyOf 2)`	null	Alternative
`watchingEnabled`	JSON	Optional
`watchingEnabled (anyOf 1)`	boolean	Alternative	Whether the ability for users to watch issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details. Read only: true
`watchingEnabled (anyOf 2)`	null	Alternative

Referenced models: Get time tracking settings — response body

Get time tracking settings — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the time tracking configuration.
`defaultUnit`	JSON	Optional
`defaultUnit (anyOf 1)`	string	Alternative	The default unit of time applied to logged time. Known values: minute, hour, day, week
`defaultUnit (anyOf 2)`	null	Alternative
`timeFormat`	JSON	Optional
`timeFormat (anyOf 1)`	string	Alternative	The format that will appear on an issue's Time Spent field. Known values: pretty, days, hours
`timeFormat (anyOf 2)`	null	Alternative
`workingDaysPerWeek`	JSON	Optional
`workingDaysPerWeek (anyOf 1)`	JSON	Alternative
`workingDaysPerWeek (anyOf 1) (anyOf 1)`	number	Alternative	The number of days in a working week. Format: double
`workingDaysPerWeek (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workingDaysPerWeek (anyOf 2)`	null	Alternative
`workingHoursPerDay`	JSON	Optional
`workingHoursPerDay (anyOf 1)`	JSON	Alternative
`workingHoursPerDay (anyOf 1) (anyOf 1)`	number	Alternative	The number of hours in a working day. Format: double
`workingHoursPerDay (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workingHoursPerDay (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getconfiguration. Catalog operation: getconfiguration. 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: ["read:jira-user"]

Official provider source

Report an issue with this page