API ReferenceToolkits

List grant_context optionsv3.1

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

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

Lists the grant_context keys and values this toolkit accepts. Pass them in the Get required scopes request to tailor the recommendation to your OAuth app or account.

Authorization

ApiKeyAuth
x-api-key<token>

Project API key authentication

In: header

Path Parameters

toolkit_slugstringRequired

Toolkit to list grant_context options 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": "string",  "toolkit_version": "string",  "grant_context_keys": [    {      "key": "string",      "allowed_values": [        "string"      ]    }  ]}
Edit this page on GitHub