Skip to navigation

Authorizations Resource

View as Markdown

A user authorization is created to share access between users on the same account. One user can be given access to sign, manage, or send on behalf of another. These endpoints allow you to create, delete, and manage user authorizations.

Methods supported

MethodDescription
createUserAuthorizationPOST /restapi/v2.1/accounts/{accountId}/users/{userId}/authorization
Creates a user authorization.
createUserAuthorizationsPOST /restapi/v2.1/accounts/{accountId}/users/{userId}/authorizations
Create or update multiple user authorizations.
deleteUserAuthorizationDEL /restapi/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}
Deletes the user authorization.
deleteUserAuthorizationsDEL /restapi/v2.1/accounts/{accountId}/users/{userId}/authorizations
Delete multiple user authorizations.
getAgentUserAuthorizationsGET /restapi/v2.1/accounts/{accountId}/users/{userId}/authorizations/agent
Returns the authorizations for which the specified user is the agent user.
getPrincipalUserAuthorizationsGET /restapi/v2.1/accounts/{accountId}/users/{userId}/authorizations
Returns the authorizations for which the specified user is the principal user.
getUserAuthorizationGET /restapi/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}
Returns the user authorization for a given authorization ID.
updateUserAuthorizationPUT /restapi/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}
Updates the start or end date for a user authorization.

Authorizations properties

PropertyTypeDescription
agentUserauthorizationUser
authorizationIdstring
createdstringThe UTC DateTime when the workspace user authorization was created.
createdBystring
endDatestring
modifiedstring
modifiedBystringThe user ID (GUID) of the user who last modified this user record. This property is read-only.
permissionstring
principalUserauthorizationUser
startDatestring
taskSourcestring
taskTypestring