Atlassian: Get invalid JQL searches

Atlassian jql.getAuditEntries: arguments, response, policy and SDK examples.

Operation atlassian.getauditentries

Provider route: GET /{cloudId}/rest/api/3/invalid-jqls-access-log. 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["jql"]["getAuditEntries"]>[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.jql.getAuditEntries(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.jql.get_audit_entries(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}$
`query`	object	Optional	Additional keys: not allowed
`query.userAccountId`	string	Optional
`query.nextPageToken`	string	Optional
`query.maxResults`	integer	Optional	Format: int32

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 invalid JQL searches — response body

Referenced models: Get invalid JQL searches — response body

Schemas

Get invalid JQL searches — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`entries`	JSON	Optional
`entries (anyOf 1)`	array	Alternative
`entries (anyOf 1)[]`	Model	Each item	Expand Get invalid JQL searches — response body — entries array item
`entries (anyOf 2)`	null	Alternative
`isLast`	JSON	Optional
`isLast (anyOf 1)`	boolean	Alternative
`isLast (anyOf 2)`	null	Alternative
`nextPageToken`	JSON	Optional
`nextPageToken (anyOf 1)`	string	Alternative
`nextPageToken (anyOf 2)`	null	Alternative
`nextPageURL`	JSON	Optional
`nextPageURL (anyOf 1)`	string	Alternative
`nextPageURL (anyOf 2)`	null	Alternative

Referenced models: Get invalid JQL searches — response body — entries array item

Get invalid JQL searches — response body — entries array item

Field	Type	Presence	Description and constraints
`$`	object	Root
`caller`	JSON	Optional
`caller (anyOf 1)`	string	Alternative
`caller (anyOf 2)`	null	Alternative
`createdAt`	JSON	Optional
`createdAt (anyOf 1)`	string	Alternative
`createdAt (anyOf 2)`	null	Alternative
`filterId`	JSON	Optional
`filterId (anyOf 1)`	string	Alternative
`filterId (anyOf 2)`	null	Alternative
`jql`	JSON	Optional
`jql (anyOf 1)`	string	Alternative
`jql (anyOf 2)`	null	Alternative
`requestUrl`	JSON	Optional
`requestUrl (anyOf 1)`	string	Alternative
`requestUrl (anyOf 2)`	null	Alternative
`user`	JSON	Optional
`user (anyOf 1)`	Model	Alternative	Expand Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self
`user (anyOf 2)`	null	Alternative
`userAgent`	JSON	Optional
`userAgent (anyOf 1)`	string	Alternative
`userAgent (anyOf 2)`	null	Alternative
`validationMessage`	JSON	Optional
`validationMessage (anyOf 1)`	string	Alternative
`validationMessage (anyOf 2)`	null	Alternative

Referenced models: Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self

Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self

Field	Type	Presence	Description and constraints
`$`	object	Root
`accountId`	JSON	Optional
`accountId (anyOf 1)`	string	Alternative
`accountId (anyOf 2)`	null	Alternative
`active`	JSON	Optional
`active (anyOf 1)`	boolean	Alternative
`active (anyOf 2)`	null	Alternative
`avatarUrls`	JSON	Optional
`avatarUrls (anyOf 1)`	Model	Alternative	Expand Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self avatar Urls 16x16, 24x24, 32x32, 48x48
`avatarUrls (anyOf 2)`	null	Alternative
`displayName`	JSON	Optional
`displayName (anyOf 1)`	string	Alternative
`displayName (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative
`key (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	Format: uri
`self (anyOf 2)`	null	Alternative

Referenced models: Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self avatar Urls 16x16, 24x24, 32x32, 48x48

Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self avatar Urls 16x16, 24x24, 32x32, 48x48

Field	Type	Presence	Description and constraints
`$`	object	Root
`16x16`	JSON	Optional
`16x16 (anyOf 1)`	string	Alternative	Format: uri
`16x16 (anyOf 2)`	null	Alternative
`24x24`	JSON	Optional
`24x24 (anyOf 1)`	string	Alternative	Format: uri
`24x24 (anyOf 2)`	null	Alternative
`32x32`	JSON	Optional
`32x32 (anyOf 1)`	string	Alternative	Format: uri
`32x32 (anyOf 2)`	null	Alternative
`48x48`	JSON	Optional
`48x48 (anyOf 1)`	string	Alternative	Format: uri
`48x48 (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getauditentries. Catalog operation: getauditentries. 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

Report an issue with this page