ReauthoriseConnectionRequest

Starts a fresh sign-in for a connection the practice already has.

Properties

Name Type Description
redirectUrlstring

Where to send the browser once the platform has redirected back. A literal [code] in
the URL is replaced with the connection's code — which is unchanged by a reauthorisation.

Where to send the browser once the platform has redirected back. A literal [code] in
the URL is replaced with the connection's code — which is unchanged by a reauthorisation.

apiKeystring

The fresh API key, for platforms that connect with one instead of a sign-in flow. Ignored on
OAuth platforms; required when reconnecting an API-key platform.

The fresh API key, for platforms that connect with one instead of a sign-in flow. Ignored on
OAuth platforms; required when reconnecting an API-key platform.

useExtendedScopesboolean

The access level for the new grant, where the platform offers extended scopes. Omit to keep
the level the connection already has.

The access level for the new grant, where the platform offers extended scopes. Omit to keep
the level the connection already has.

JSON Example

{
  "redirectUrl": "string",
  "apiKey": "string",
  "useExtendedScopes": false
}

Used By Operations