ESignPermissionProfiles: GetESignPermissionProfiles

When you create or invite a new member in Rooms, the system creates an eSignature account for the member at the same time. This method returns a list of the eSignature permission profiles that the current user may be able to assign to a new member. The current user may not assign a permission higher than their own permission.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/esign_permission_profiles

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The globally unique identifier (GUID) for the account.

Responses

CodeDescriptionReference
200

Permission profiles successfully retrieved.

ESignPermissionProfileList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

ESignPermissionProfiles::GetESignPermissionProfiles

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

ESignAccountRoleSettings

This object contains details about the permissions associated with a eSignature permission profile.

allowAccountManagementboolean

A Boolean specifying whether users with this eSignature permission profile can manage the Rooms account. This property is read only and has the following values:

  • DS Admin permission profile: true
  • DS Sender permission profile: false
  • DS Viewer permission profile: false

ESignPermissionProfile

When an administrator or authorized member invites a new user to become an account member, the system also creates an eSignature account for the invitee at the same time. This object contains information about the eSignature permission profile, which controls member access to the eSignature account.

eSignPermissionProfileIdstring

When an administrator or authorized member invites a new user to become an account member, the system also creates an eSignature account for the invitee at the same time. The eSignPermissionProfileId is the id of the eSignature permission set to assign to the member.

namestring

The name of the eSignature permission profile. Valid values are:

settingsESignAccountRoleSettings

the eSignature account role settings associated with the permission profile.

ESignPermissionProfileList

This object contains a list of eSignature permission profiles.

permissionProfiles[ESignPermissionProfile]

An array of eSignature permissionProfile objects.

}} />