Connect Configurations

Updates the existing Connect OAuth configuration for the account

PUT
/v2.1/accounts/{accountId}/connect/oauth

Updates the existing Connect OAuth configuration for the account.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

Request Body

application/json

A complex object describing a Connect OAuth configuration.

authorizationServerUrl?string

The token URL for your authorization server or OAuth service.

This property is required.

clientId?string

The client ID assigned to your app by your authorization server or OAuth service.

This property is required.

clientSecret?string

The secret value provided by your authorization server.

This property is required.

customParameters?
scope?string

The scopes that your app will request from the authorization server.

This property is optional.

Note: If you are using Azure, this value is the application ID URI of the secified resource affixed with the .default. For example: api://{{clientId}}/.default

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/connect/oauth" \  -H "Content-Type: application/json" \  -d '{}'
{  "authorizationServerUrl": "string",  "clientId": "string",  "clientSecret": "string",  "customParameters": {    "property1": "string",    "property2": "string"  },  "scope": "string"}