Account Permission Profiles
Creates a new permission profile for an account
This method creates a new permission profile for an account.
Related topics
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.
Query Parameters
include?string
A comma-separated list of additional properties to return in the response. The only valid value for this request is metadata, which returns metadata indicating whether the properties associated with the account permission profile are editable.
Request Body
application/json
This object defines the account permissions for a profile that you can apply to a group of users.
modifiedByUsername?string
The username of the user who last modified the permission profile.
modifiedDateTime?string
The date and time when the permission profile was last modified.
permissionProfileId?string
The ID of the permission profile.
Use AccountPermissionProfiles: list to get a list of permission profiles and their IDs.
You can also download a CSV file of all permission profiles and their IDs from the Settings > Permission Profiles page of your eSignature account page.
permissionProfileName?string
The name of the account permission profile.
Example: Account Administrator
settings?
This object defines account permissions for users who are associated with the account permission profile.
userCount?string
The total number of users in the group associated with the account permission profile.
users?array<>
A list of user objects containing information about the users who are associated with the account permission profile.
Response Body
application/json
application/json
curl -X POST "https://example.com/v2.1/accounts/string/permission_profiles" \ -H "Content-Type: application/json" \ -d '{}'{ "modifiedByUsername": "string", "modifiedDateTime": "string", "permissionProfileId": "string", "permissionProfileName": "string", "settings": { "accountAgreementsAccessType": "string", "accountManagementGranular": { "allowManageAccountSecuritySettings": "string", "allowManageAccountSettings": "string", "allowManageAdmins": "string", "allowManageConnect": "string", "allowManageDocumentRetention": "string", "allowManageEnvelopeTransfer": "string", "allowManageGroupsButNotUsers": "string", "allowManageJointAgreements": "string", "allowManageReporting": "string", "allowManageSharing": "string", "allowManageSigningGroups": "string", "allowManageStamps": "string", "allowManageUsers": "string", "allowViewUsers": "string" }, "allowAccountManagement": "string", "allowApiAccess": "string", "allowApiAccessToAccount": "string", "allowApiSendingOnBehalfOfOthers": "string", "allowApiSequentialSigning": "string", "allowAutoTagging": "string", "allowBulkSending": "string", "allowDocuSignDesktopClient": "string", "allowedAddressBookAccess": "string", "allowedClickwrapsAccess": "string", "allowedDocumentTemplateLibraryAccess": "string", "allowedOrchestrationAccess": "string", "allowedTemplateAccess": "string", "allowedToBeEnvelopeTransferRecipient": "string", "allowEnvelopeSending": "string", "allowESealRecipients": "string", "allowPowerFormsAdminToAccessAllPowerFormEnvelopes": "string", "allowSendersToSetRecipientEmailLanguage": "string", "allowSignerAttachments": "string", "allowSupplementalDocuments": "string", "allowTaggingInSendAndCorrect": "string", "allowTransactions": "string", "allowVaulting": "string", "allowWetSigningOverride": "string", "canBulkUploadAgreements": "string", "canCreateTransaction": "string", "canCreateWorkspaces": "string", "canDeleteDocumentsInTransaction": "string", "canDeleteTransaction": "string", "canManageAgreementDeskRequest": "string", "canManageAgreementDeskRequestSetting": "string", "canSendEnvelopesViaSMS": "string", "disableDocumentUpload": "string", "disableOtherActions": "string", "enableApiRequestLogging": "string", "enableKeyTermsSuggestionsByDocumentType": "string", "enableRecipientViewingNotifications": "string", "enableSequentialSigningInterface": "string", "enableTransactionPointIntegration": "string", "playbookAccess": "string", "powerFormRole": "string", "receiveCompletedSelfSignedDocumentsAsEmailLinks": "string", "supplementalDocumentsMustAccept": "string", "supplementalDocumentsMustRead": "string", "supplementalDocumentsMustView": "string", "useNewDocuSignExperienceInterface": "string", "useNewSendingInterface": "string", "vaultingMode": "string", "webForms": "string" }, "userCount": "string", "users": [ { "activationAccessCode": "string", "company": "string", "connectConfigurations": [ { "configurationtype": "string", "connectId": "string", "enabled": "string", "hasAccess": "string", "senderSearchableItems": [ "string" ] } ], "countryCode": "string", "createdDateTime": "string", "customSettings": [ { "errorDetails": { "errorCode": "string", "message": "string" }, "name": "string", "originalValue": "string", "value": "string" } ], "defaultAccountId": "string", "email": "string", "enableConnectForUser": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "firstName": "string", "forgottenPasswordInfo": { "forgottenPasswordAnswer1": "string", "forgottenPasswordAnswer2": "string", "forgottenPasswordAnswer3": "string", "forgottenPasswordAnswer4": "string", "forgottenPasswordQuestion1": "string", "forgottenPasswordQuestion2": "string", "forgottenPasswordQuestion3": "string", "forgottenPasswordQuestion4": "string" }, "groupList": [ { "accessType": "string", "dsGroupId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "groupId": "string", "groupName": "string", "groupType": "string", "isManagedByScim": true, "lastModifiedOn": "string", "permissionProfileId": "string", "userGroupType": "string", "users": [ { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" } ], "usersCount": "string" } ], "hasRemoteNotary": true, "homeAddress": { "address1": "string", "address2": "string", "city": "string", "country": "string", "fax": "string", "phone": "string", "postalCode": "string", "stateOrProvince": "string", "zipPlus4": "string" }, "initialsImageUri": "string", "isAdmin": "string", "isAlternateAdmin": "string", "isManagedByScim": "string", "isMembershipManagedByScim": "string", "isNAREnabled": "string", "jobTitle": "string", "lastLogin": "string", "lastName": "string", "licenseStatus": "string", "licenseType": "string", "loginStatus": "string", "middleName": "string", "password": "string", "passwordExpiration": "string", "permissionProfileId": "string", "permissionProfileName": "string", "profileImageUri": "string", "sendActivationEmail": "string", "sendActivationOnInvalidLogin": "string", "signatureImageUri": "string", "subscribe": "string", "suffixName": "string", "title": "string", "uri": "string", "userAddedToAccountDateTime": "string", "userId": "string", "userName": "string", "userProfileLastModifiedDate": "string", "userSettings": { "accountAgreementsAccessType": "string", "accountManagementGranular": { "canManageAccountSecuritySettings": "string", "canManageAccountSettings": "string", "canManageAdmins": "string", "canManageConnect": "string", "canManageDocumentRetention": "string", "canManageEnvelopeTransfer": "string", "canManageGroupsButNotUsers": "string", "canManageJointAgreements": "string", "canManageReporting": "string", "canManageSharing": "string", "canManageSigningGroups": "string", "canManageStamps": "string", "canManageUsers": "string", "canViewUsers": "string" }, "adminOnly": "string", "allowAccessToAllAccountAgreements": "string", "allowAutoTagging": "string", "allowedDocumentTemplateLibraryAccess": "string", "allowedOrchestrationAccess": "string", "allowEnvelopeTransferTo": "string", "allowEsealRecipients": "string", "allowPowerFormsAdminToAccessAllPowerFormEnvelope": "string", "allowRecipientLanguageSelection": "string", "allowSendOnBehalfOf": "string", "allowSupplementalDocuments": "string", "allowTransactions": "string", "anchorTagVersionedPlacementEnabled": "string", "apiAccountWideAccess": "string", "apiCanExportAC": "string", "bulkSend": "string", "canBulkUploadAgreements": "string", "canChargeAccount": "string", "canCreateTransaction": "string", "canDeleteDocumentsInTransaction": "string", "canDeleteTransaction": "string", "canEditSharedAddressbook": "string", "canLockEnvelopes": "string", "canManageAccount": "string", "canManageAgreementParties": "string", "canManageDistributor": "string", "canManageTemplates": "string", "canSendAPIRequests": "string", "canSendEnvelope": "string", "canSendEnvelopesViaSMS": "string", "canSignEnvelope": "string", "canUseScratchpad": "string", "canUseSmartContracts": "string", "disableDocumentUpload": "string", "disableOtherActions": "string", "enableDSPro": "string", "enableKeyTermsSuggestionsByDocumentType": "string", "enableSequentialSigningAPI": "string", "enableSequentialSigningUI": "string", "enableSignerAttachments": "string", "enableSignOnPaperOverride": "string", "enableTransactionPoint": "string", "enableVaulting": "string", "expressSendOnly": "string", "isManagedByScim": "string", "isMembershipManagedByScim": "string", "locale": "string", "localePolicy": { "addressFormat": "string", "allowRegion": "string", "calendarType": "string", "cultureName": "string", "currencyCode": "string", "currencyNegativeFormat": "string", "currencyPositiveFormat": "string", "customDateFormat": "string", "customSignDateFormat": "string", "customSignTimeFormat": "string", "customTimeFormat": "string", "dateFormat": "string", "effectiveAddressFormat": "string", "effectiveCalendarType": "string", "effectiveCurrencyCode": "string", "effectiveCurrencyNegativeFormat": "string", "effectiveCurrencyPositiveFormat": "string", "effectiveCustomDateFormat": "string", "effectiveCustomTimeFormat": "string", "effectiveDateFormat": "string", "effectiveInitialFormat": "string", "effectiveNameFormat": "string", "effectiveTimeFormat": "string", "effectiveTimeZone": "string", "initialFormat": "string", "nameFormat": "string", "signDateFormat": "string", "signTimeFormat": "string", "timeFormat": "string", "timeZone": "string" }, "manageClickwrapsMode": "string", "modifiedBy": "string", "modifiedDate": "string", "modifiedPage": "string", "newSendUI": "string", "powerFormMode": "string", "recipientViewedNotification": "string", "sealIdentifiers": [ { "sealDisplayName": "string", "sealName": "string" } ], "selfSignedRecipientEmailDocument": "string", "senderEmailNotifications": { "changedSigner": "string", "clickwrapResponsesLimitNotificationEmail": "string", "commentsOnlyPrivateAndMention": "string", "commentsReceiveAll": "string", "deliveryFailed": "string", "envelopeComplete": "string", "offlineSigningFailed": "string", "powerformResponsesLimitNotificationEmail": "string", "purgeDocuments": "string", "recipientViewed": "string", "senderEnvelopeDeclined": "string", "withdrawnConsent": "string" }, "signerEmailNotifications": { "agentNotification": "string", "carbonCopyNotification": "string", "certifiedDeliveryNotification": "string", "commentsOnlyPrivateAndMention": "string", "commentsReceiveAll": "string", "documentMarkupActivation": "string", "envelopeActivation": "string", "envelopeComplete": "string", "envelopeCorrected": "string", "envelopeDeclined": "string", "envelopeVoided": "string", "faxReceived": "string", "offlineSigningFailed": "string", "purgeDocuments": "string", "reassignedSigner": "string", "whenSigningGroupMember": "string" }, "supplementalDocumentIncludeInDownload": "string", "supplementalDocumentsMustAccept": "string", "supplementalDocumentsMustRead": "string", "supplementalDocumentsMustView": "string", "templateActiveCreation": "string", "templateApplyNotify": "string", "templateAutoMatching": "string", "templateMatchingSensitivity": "string", "templatePageLevelMatching": "string", "timezoneDST": "string", "timezoneMask": "string", "timezoneOffset": "string", "timezoneSendingPref": "string", "timezoneSigningPref": "string", "transactionPointSiteNameURL": "string", "transactionPointUserName": "string", "vaultingMode": "string", "webForms": "string" }, "userStatus": "string", "userType": "string", "workAddress": { "address1": "string", "address2": "string", "city": "string", "country": "string", "fax": "string", "phone": "string", "postalCode": "string", "stateOrProvince": "string", "zipPlus4": "string" } } ]}Gets a list of permission profiles GET
This method returns a list of permission profiles that are associated with an account. Example: ```json { "permissionProfiles": [ { "permissionProfileId": "1665536", "permissionProfileName": "Account Administrator", "modifiedDateTime": "2018-03-26T03:54:40.4470000Z", "modifiedByUsername": "" }, { "permissionProfileId": "1665537", "permissionProfileName": "DocuSign Sender", "modifiedDateTime": "2018-03-26T03:54:40.4470000Z", "modifiedByUsername": "" }, { "permissionProfileId": "1665538", "permissionProfileName": "DocuSign Viewer", "modifiedDateTime": "2016-06-02T01:53:15.6830000Z", "modifiedByUsername": "" }, { "permissionProfileId": "10325926", "permissionProfileName": "DS Manage Company Member Accounts", "modifiedDateTime": "2020-05-15T00:28:36.8230000Z", "modifiedByUsername": "Nat Irving" } ] } ```
Returns a permission profile for an account GET
This method returns information about a specific permission profile that is associated with an account. ### Related topics - [How to set a permission profile](https://developers.docusign.com/docs/esign-rest-api/how-to/permission-profile-setting/)