Authorizations

Returns the authorizations for which the specified user is the principal user.

Changed on

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

To call this endpoint, you must be an account administrator or you must be the specified principal user.

get/v2.1/accounts/{accountId}/users/{userId}/authorizations

Request

  • Base URL
    https://www.docusign.net/restapi
  • URL
    https://www.docusign.net/restapi/v2.1/accounts/{accountId}/users/{userId}/authorizations
  • Auth
    none declared

Path parameters

accountIdstring required

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

userIdstring required

The ID of the principal user.

Query parameters

active_onlystring

When true, return only active authorizations. The default value is true.

countstring

The maximum number of results to return.

email_substringstring

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

include_closed_usersstring

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.

permissionsstring

Filters results by authorization permission. Valid values:

  • Send
  • Manage
  • Sign
start_positionstring

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_sourcestring
task_typestring
user_name_substringstring

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

Successful response.

Changes