docusign.authorizations.create-user-authorization

Creates an authorization allowing one user to send and/or manage envelopes on behalf of another user. The agent user acts on behalf of the principal user. The principal user is specified by the userId path parameter. The agent user is specified in the request body. Each principal user can only share signing permission with one agent user. Specify in the request the level of access to share with the agent user. If you share signing access, the agent user will receive an email notification. To call this endpoint: * You must be an account administrator or you must be the principal user. * The agent user and principal user must belong to the same account. * At least one of the following account settings must be enabled: AllowDelegatedSigning, AllowManagingEnvelopesOnBehalfOfOthers, AllowEditingEnvelopesOnBehalfOfOthers, AllowSendingEnvelopesOnBehalfOfOthers. These settings correspond to the level of access you can set for the authorization.

Creates a user authorization.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
userid	string	Yes	—	The ID of the principal user.
agentuser	json	No	—	—
enddate	string	No	—	The UTC DateTime to end the authorization. The default value is the max UTC value (9999-12-31T23:59:59.0000000+00:00).
permission	string	No	—	The permission level to grant the agent. Valid values: * Send * Manage * Sign * Edit This property is required.
startdate	string	No	—	The UTC DateTime to initiate the authorization. The default value is the current date and time.
tasksource	string	No	—	—
tasktype	string	No	—	—

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
userid	string	Yes	—	The ID of the principal user.
agentuser	json	No	—	—
enddate	string	No	—	The UTC DateTime to end the authorization. The default value is the max UTC value (9999-12-31T23:59:59.0000000+00:00).
permission	string	No	—	The permission level to grant the agent. Valid values: * Send * Manage * Sign * Edit This property is required.
startdate	string	No	—	The UTC DateTime to initiate the authorization. The default value is the current date and time.
tasksource	string	No	—	—
tasktype	string	No	—	—
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call POST /v2.1/accounts/{accountId}/users/{userId}/authorization
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform POST /v2.1/accounts/{accountId}/users/{userId}/authorization
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.authorizations.create-user-authorization",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "userid": "value"
  }
}