v1

latestSwagger 2.02026-07-134146194.6 MB
ConnectConfigurations

Set up Connect OAuth for the specified account.

Sets up Connect OAuth for the specified account using an authorization server of your choice. To use this endpoint, get the client ID and client secret from your authorization server.

When you call this endpoint, Docusign requests an access token from your authorization server. Docusign will use that token in the Authorization HTTP header of your account's Connect messages. Finally, your listener will be responsible for validating the token by calling the authorization server.

<ds-inlinemessage> To use this method, you must be an account administrator and Connect must be enabled on your account. </ds-inlinemessage>

Related topics:

  • OAuth for Docusign Connect
post/v2.1/accounts/{accountId}/connect/oauth

Path parameters

accountIdstring required

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

Request body

authorizationServerUrlstring

The token URL for your authorization server or OAuth service.

This property is required.

clientIdstring

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

This property is required.

clientSecretstring

The secret value provided by your authorization server.

This property is required.

customParametersobject
scopestring

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

Successful response.