CreateThirdPartyConnectionRequest
Request for creating a new ThirdPartyConnection
Properties
| Name | Type | Description |
|---|---|---|
| name | string | Display name for the connection |
Display name for the connection | ||
| redirectUrl | string | URL to redirect the user to after OAuth flow completes. |
URL to redirect the user to after OAuth flow completes. | ||
| platform* | string | The platform identifier (e.g., "Xero", "FreeAgent", "Xama") |
The platform identifier (e.g., "Xero", "FreeAgent", "Xama") | ||
| oAuthClientId | string | OAuth client ID for OAuthClientCredentials flow (e.g., Xama OAuth ID) |
OAuth client ID for OAuthClientCredentials flow (e.g., Xama OAuth ID) | ||
| oAuthClientSecret | string | OAuth client secret for OAuthClientCredentials flow (e.g., Xama OAuth Secret) |
OAuth client secret for OAuthClientCredentials flow (e.g., Xama OAuth Secret) | ||
| organizationId | string | External organization/client ID for OAuthClientCredentials flow (e.g., Xama Client ID) |
External organization/client ID for OAuthClientCredentials flow (e.g., Xama Client ID) | ||
JSON Example
{
"name": "string",
"redirectUrl": "string",
"platform": "string",
"oAuthClientId": "string",
"oAuthClientSecret": "string"
}