Toolkits

List grant contexts

Changed on

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.

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

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/toolkits/{toolkit_slug}/scopes/grant_context
  • Auth
    API key in header x-api-key

Path parameters

toolkit_slugstring required

Toolkit to list grant contexts for.

Query parameters

auth_scheme'OAUTH2' | 'OAUTH1' | 'API_KEY' | 'BASIC' | 'BILLCOM_AUTH' | 'BEARER_TOKEN' | 'GOOGLE_SERVICE_ACCOUNT' | 'NO_AUTH' | 'BASIC_WITH_JWT' | 'CALCOM_AUTH' | 'SERVICE_ACCOUNT' | 'SAML' | 'DCR_OAUTH' | 'CIMD_OAUTH' | 'S2S_OAUTH2'

Auth scheme the connection will use. Defaults to OAUTH2.

toolkit_versionstring

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

Response

Successfully discovered the toolkit's grant-context dimensions

auth_schemestring required

Auth scheme whose scope catalog the vocabulary was read from.

toolkit_versionstring required

Concrete toolkit version the answer was computed from; pass it back as toolkit_version to pin.

default_grant_contextobject required

The grant_context assumed when you pass none — pass a dimension and its selected value only to override or extend it.

Changes