Atlassian: Get permission scheme grant

← Permission schemes operations · Get started

Operation atlassian.getpermissionschemegrant

Provider route: GET /{cloudId}/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}. 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["permissionSchemes"]["getPermissionSchemeGrant"]>[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.permissionSchemes.getPermissionSchemeGrant(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.permission_schemes.get_permission_scheme_grant(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.schemeId	integer	Required within parent	Format: int64
path.permissionId	integer	Required within parent	Format: int64
query	object	Optional	Additional keys: not allowed
query.expand	string	Optional

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 Create permission grant — response body

Referenced models: Create permission grant — response body

Schemas

Create permission grant — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details about a permission granted to a user or group. Additional keys: allowed
holder	JSON	Optional
holder (anyOf 1)	Model	Alternative	Expand Create permission grant — response body — holder expand, parameter, type, value The user or group being granted the permission. It consists of a `type`, a type-dependent `parameter` and a type-dependent `value`. See [Holder object](../api-group-permission-schemes/#holder-object) in *Get all permission schemes* for more information.
holder (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	JSON	Alternative
id (anyOf 1) (anyOf 1)	integer	Alternative	The ID of the permission granted details. Format: int64 Read only: true
id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id (anyOf 2)	null	Alternative
permission	JSON	Optional
permission (anyOf 1)	string	Alternative	The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See [Built-in permissions](../api-group-permission-schemes/#built-in-permissions) in *Get all permission schemes* for more information about the built-in permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information about custom permissions.
permission (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the permission granted details. Format: uri Read only: true
self (anyOf 2)	null	Alternative

Referenced models: Create permission grant — response body — holder expand, parameter, type, value

Create permission grant — response body — holder expand, parameter, type, value

Field	Type	Presence	Description and constraints
$	object	Root	Details of a user, group, field, or project role that holds a permission. See [Holder object](../api-group-permission-schemes/#holder-object) in *Get all permission schemes* for more information.
expand	JSON	Optional
expand (anyOf 1)	string	Alternative	Expand options that include additional permission holder details in the response. Read only: true
expand (anyOf 2)	null	Alternative
parameter	JSON	Optional
parameter (anyOf 1)	string	Alternative	As a group's name can change, use of `value` is recommended. The identifier associated withthe `type` value that defines the holder of the permission.
parameter (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of permission holder.
type (anyOf 2)	null	Alternative
value	JSON	Optional
value (anyOf 1)	string	Alternative	The identifier associated with the `type` value that defines the holder of the permission.
value (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getpermissionschemegrant. Catalog operation: getpermissionschemegrant. 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-work"]

Official provider source