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.
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"]["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 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_user_authorizations_get_principal_user_authorizations(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 | |
path.userId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.active_only | string | Optional | |
query.count | string | Optional | |
query.email_substring | string | Optional | |
query.include_closed_users | string | Optional | |
query.permissions | string | Optional | |
query.start_position | string | Optional | |
query.task_source | string | Optional | |
query.task_type | string | Optional | |
query.user_name_substring | string | Optional |
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 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
Schemas
Section titled “Schemas”Returns the authorizations for which the specified user is the agent user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authorizations | array | Optional | |
authorizations[] | Model | Each item | Expand Returns the user authorization for a given authorization ID — response body |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The 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. |
previousUri | string | Optional | The 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. |
resultSetSize | string | Optional | The 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`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex object describing a user authorization. |
agentUser | Model | Optional | Expand esignature:Envelopes Shares Get Envelopes Share — response body — agent User The user who can act on behalf of the principal user. |
authorizationId | string | Optional | The ID of the user authorization. |
created | string | Optional | The UTC DateTime when the workspace user authorization was created. |
createdBy | string | Optional | The name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]` |
endDate | string | Optional | The UTC DateTime at which the authorization will expire. |
modified | string | Optional | The UTC DateTime when the workspace user authorization was last updated. |
modifiedBy | string | Optional | The name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]` |
permission | string | Optional | The [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. |
principalUser | Model | Optional | Expand esignature:Envelopes Shares Get Envelopes Share — response body — agent User The user for whom the agent user acts. |
startDate | string | Optional | The UTC DateTime at which the authorization will start. |
taskSource | string | Optional | |
taskType | string | Optional |
Referenced models: esignature:Envelopes Shares Get Envelopes Share — response body — agent User
esignature:Envelopes Shares Get Envelopes Share — response body — agent User
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | string | Optional | The account ID. |
email | string | Optional | The email address of the authorization user. |
name | string | Optional | The name of the authorization user. |
userId | string | Optional | The ID of the authorization user. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.