Skip to content

DocuSign: Returns the authorizations for which the specified user is the principal user

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

← Esignature operations · Get started

Operation docusign.esignature_userauthorizations_getprincipaluserauthorizations

Provider route: GET /restapi/v2.1/accounts/{accountId}/users/{userId}/authorizations. 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"]["esignatureUserAuthorizationsGetPrincipalUserAuthorizations"]>[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.esignatureUserAuthorizationsGetPrincipalUserAuthorizations(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_authorizations_get_principal_user_authorizations(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.userIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.active_onlystringOptional
query.countstringOptional
query.email_substringstringOptional
query.include_closed_usersstringOptional
query.permissionsstringOptional
query.start_positionstringOptional
query.task_sourcestringOptional
query.task_typestringOptional
query.user_name_substringstringOptional

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 authorizations for which the specified user is the agent user — response body

Referenced models: Returns the authorizations for which the specified user is the agent user — response body

Returns the authorizations for which the specified user is the agent user — response body
FieldTypePresenceDescription and constraints
$objectRoot
authorizationsarrayOptional
authorizations[]ModelEach itemExpand Returns the user authorization for a given authorization ID — response body
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

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_userauthorizations_getprincipaluserauthorizations. Catalog operation: esignature:UserAuthorizations_GetPrincipalUserAuthorizations. 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.