API ReferenceToolkits

List grant contextsv3.1

GET
/api/v3.1/toolkits/{toolkit_slug}/scopes/grant_context

Experimental: this endpoint is in beta and its contract may change.

List of contexts in which you want to grant scopes to your user. Pass a dimension and its selected value in the grant_context field of the Get required scopes request to tailor the scope recommendation.

In the Jira example, default_grant_context is {"scope_family": "classic"}, so a recommendation with no grant_context uses classic scopes. Pass {"scope_family": "granular"} to get granular scopes instead.

Authorization

ApiKeyAuth
x-api-key<token>

Project API key authentication

In: header

Path Parameters

toolkit_slugstringRequired

Toolkit to list grant contexts for.

Query Parameters

auth_schemeenum

Auth scheme the connection will use. Defaults to OAUTH2.

Default: "OAUTH2"
Possible values:
OAUTH2OAUTH1API_KEYBASICBILLCOM_AUTHBEARER_TOKENGOOGLE_SERVICE_ACCOUNTNO_AUTHBASIC_WITH_JWTCALCOM_AUTHSERVICE_ACCOUNTSAMLDCR_OAUTHCIMD_OAUTHS2S_OAUTH2
toolkit_versionstring

Toolkit version to read the catalog from; defaults to the latest published version. Pass a concrete version to pin.

Default: "latest"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v3.1/toolkits/string/scopes/grant_context"
{  "auth_scheme": "OAUTH2",  "toolkit_version": "20260917_00",  "grant_context_dimensions": [    {      "dimension": "scope_family",      "description": "Which Atlassian OAuth scope catalog to draw from: classic scopes cover broad product areas, granular scopes name individual operations. Defaults to classic, matching the scopes our Jira OAuth app requests today.",      "values": [        "classic",        "granular"      ]    }  ],  "default_grant_context": {    "scope_family": "classic"  }}
Edit this page on GitHub