Additional OAuth scopes

The Make an API Call module connection will not work if the required scopes of the endpoint are not in the OAuth connection. To correct this, allow users to define additional scopes when they create a connection.

Make an API Call parameters: non-editable connection

{
	"type": "banner",
	"text": "Your connection must contain the required scopes for your API call. If you receive an error, create a new connection with the necessary Additional scopes.",
	"theme": "info"
}

If you encounter the warning String is longer than the maximum length of 256. , wrap it in an RPC.

Make an API Call parameters: editable connection

{
	"type": "banner",
	"text": "Your connection must contain the required scopes for your API call. If you receive an error, edit your connection with the necessary Additional scopes.",
	"theme": "info"
}

Connection parameters

[
    {
        "name": "additionalScopes",
        "label": "Additional Scopes",
        "type": "array",
        "spec": {
            "type": "text",
            "label": "Scope"
        },
        "help": "Additional scopes are required for the __Make an API Call__ module. For details, see the [App Name API Documentation](https://link-to-doc). Add scopes for every API call you will make with this connection.",
		"labels": {
			"add": "Add scope"
		}
    },
    {
        "name": "clientId",
        "type": "text",
        "label": "Client ID",
        "advanced": true
    },
    {
        "name": "clientSecret",
        "type": "password",
        "label": "Client Secret",
        "advanced": true
    }
]

Connection communication

{
    "authorize": {
        "qs": {
            "scope": "{{join(distinct(merge(oauth.scope, ifempty(parameters.additionalScopes, emptyarray))), ',')}}",
            ...
        },
        "url": "...",
        "response": {
            "temp": {
                "code": "{{query.code}}"
            }
        }
    }
}

PreviousConnection types

NextPolling triggers

Last updated 10 months ago