POST /v1/connect/authorize/{connector}
Create an authorization request for a connector and return the URL and verifier details needed to complete the flow.
Servers
Path parameters
| Name |
Type |
Required |
Description |
connector |
String |
Yes |
|
Request headers
| Name |
Type |
Required |
Description |
Content-Type |
String |
Yes |
The media type of the request body.
Default value: "application/json"
|
Request body fields
| Name |
Type |
Required |
Description |
prompt |
String |
No |
|
installationId |
String |
No |
|
authorizationDetails[] |
Array |
No |
|
authorizationDetails[].type |
String |
No |
|
subject |
|
No |
|
additionalParams |
Object |
No |
|
validityBufferMs |
Number |
No |
|
scopes[] |
Array |
No |
|
deviceCode |
Boolean |
No |
|
resources[] |
Array |
No |
|
returnUrl |
String |
No |
|
webhook |
String |
No |
|
expiresInMs |
Number |
No |
|
audience[] |
Array |
No |
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.