Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Connect Configurations

Set up Connect OAuth for the specified account

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

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.

Related topics:

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 POST "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"}

Retrieves the Connect OAuth information for the account GET

Gets the Connect OAuth configuration for the specified account. <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](https://developers.docusign.com/platform/webhooks/connect/validation-and-security/oauth-connect/)

Delete the Connect OAuth configuration DELETE

Deletes the Connect OAuth configuration for the specified account. <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](https://developers.docusign.com/platform/webhooks/connect/validation-and-security/oauth-connect/)