Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Authorizations

Returns the authorizations for which the specified user is the agent user

GET
/v2.1/accounts/{accountId}/users/{userId}/authorizations/agent

Returns the user authorizations for which the user specified by userId is the agent user.

If the calling user is an account administrator, the full results will be returned. Otherwise, only authorizations for which the calling user is the principal user will be returned.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

userId*string

The user who is acting as the agent.

Query Parameters

active_only?string

When true, only active users are returned. The default value is false.

count?string

The maximum number of results to return.

email_substring?string

Filters returned user records by full email address or a substring of email address.

include_closed_users?string

When true, returns active and scheduled authorizations of closed users. The default value is true. This value is only applied when active_only is false.

permissions?string
start_position?string

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

task_source?string
task_type?string
user_name_substring?string

Filters results based on a full or partial user name.

Note: When you enter a partial user name, you do not use a wildcard character.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/users/string/authorizations/agent"
{  "authorizations": [    {      "agentUser": {        "accountId": "string",        "email": "string",        "name": "string",        "userId": "string"      },      "authorizationId": "string",      "created": "string",      "createdBy": "string",      "endDate": "string",      "modified": "string",      "modifiedBy": "string",      "permission": "string",      "principalUser": {        "accountId": "string",        "email": "string",        "name": "string",        "userId": "string"      },      "startDate": "string",      "taskSource": "string",      "taskType": "string"    }  ],  "endPosition": "string",  "nextUri": "string",  "previousUri": "string",  "resultSetSize": "string",  "startPosition": "string",  "totalSetSize": "string"}

Delete multiple user authorizations DELETE

Delete one or more user authorizations for a given principal user. The principal user is specified by the `userId` path parameter. To call this endpoint, you must be an account administrator or you must be the principal user for the specified authorizations.

EnvelopesShares_GetEnvelopesShares GET