DocuSign: Retrieves the Connect O Auth information for the account
DocuSign esignature.esignatureConnectOauthConfigGetConnectOauthConfig: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_connectoauthconfig_getconnectoauthconfig
Provider route: GET /restapi/v2.1/accounts/{accountId}/connect/oauth. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureConnectOauthConfigGetConnectOauthConfig"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureConnectOauthConfigGetConnectOauthConfig(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_connect_oauth_config_get_connect_oauth_config(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Set up Connect O Auth for the specified account — response body |
Referenced models: Set up Connect O Auth for the specified account — response body
Schemas
Section titled “Schemas”Set up Connect O Auth for the specified account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex object describing a Connect OAuth configuration. |
authorizationServerUrl | string | Optional | The token URL for your authorization server or OAuth service. This property is required. |
clientId | string | Optional | The client ID assigned to your app by your authorization server or OAuth service. This property is required. |
clientSecret | string | Optional | The secret value provided by your authorization server. This property is required. |
customParameters | object | Optional | Additional keys: see wildcard field |
customParameters.* | string | Additional keys | |
scope | string | Optional | 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` |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_connectoauthconfig_getconnectoauthconfig. Catalog operation: esignature:ConnectOAuthConfig_GetConnectOAuthConfig. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.