Skip to content

DocuSign: Returns the user authorization for a given authorization ID

DocuSign esignature.esignatureUserAuthorizationGetUserAuthorization: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_userauthorization_getuserauthorization

Provider route: GET /restapi/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}. Alter supplies the connection’s credentials and routing.

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"]["esignatureUserAuthorizationGetUserAuthorization"]>[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.esignatureUserAuthorizationGetUserAuthorization(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_user_authorization_get_user_authorization(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.authorizationIdstringRequired within parent
path.userIdstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Returns the user authorization for a given authorization ID — response body

Referenced models: Returns the user authorization for a given authorization ID — response body

Returns the user authorization for a given authorization ID — response body
FieldTypePresenceDescription and constraints
$objectRootA complex object describing a user authorization.
agentUserModelOptionalExpand esignature:Envelopes Shares Get Envelopes Share — response body — agent User
The user who can act on behalf of the principal user.
authorizationIdstringOptionalThe ID of the user authorization.
createdstringOptionalThe UTC DateTime when the workspace user authorization was created.
createdBystringOptionalThe name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]`
endDatestringOptionalThe UTC DateTime at which the authorization will expire.
modifiedstringOptionalThe UTC DateTime when the workspace user authorization was last updated.
modifiedBystringOptionalThe name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]`
permissionstringOptionalThe [permission level](/docs/esign-rest-api/esign101/concepts/envelopes/shared-access/) to grant the agent. Valid values:
* `Send`
* `Manage`
* `Sign`
* `Edit`

This property is required.
principalUserModelOptionalExpand esignature:Envelopes Shares Get Envelopes Share — response body — agent User
The user for whom the agent user acts.
startDatestringOptionalThe UTC DateTime at which the authorization will start.
taskSourcestringOptional
taskTypestringOptional

Referenced models: esignature:Envelopes Shares Get Envelopes Share — response body — agent User

esignature:Envelopes Shares Get Envelopes Share — response body — agent User
FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringOptionalThe account ID.
emailstringOptionalThe email address of the authorization user.
namestringOptionalThe name of the authorization user.
userIdstringOptionalThe ID of the authorization user.

SDK function policy ID: docusign.esignature_userauthorization_getuserauthorization. Catalog operation: esignature:UserAuthorization_GetUserAuthorization. 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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.