Skip to navigation
Docusign eSignature REST APIConnectConnectConfigurations

Set up Connect OAuth

View as Markdown

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.

To use this method, you must be an account administrator and Connect must be enabled on your account.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

Request

This endpoint expects an object: connectOAuthConfig

authorizationServerUrlstringOptional

The token URL for your authorization server or OAuth service.

This property is required.

clientIdstringOptional

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

This property is required.

clientSecretstringOptional

The secret value provided by your authorization server.

This property is required.

customParametersmap from strings to stringsOptional
scopestringOptional

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.
authorizationServerUrlstringOptional

The token URL for your authorization server or OAuth service.

This property is required.

clientIdstringOptional

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

This property is required.

clientSecretstringOptional

The secret value provided by your authorization server.

This property is required.

customParametersmap from strings to stringsOptional
scopestringOptional

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

Errors

400
Bad Request Error