AccountPermissionProfiles: create

Request

HTTP request

POST /v2/accounts/{accountId}/permission_profiles

Parameters

Parameter Name	Value	Description
Path Parameters
accountId	string	The external account number (int) or account ID Guid.
Optional Query Parameters
include	string	A comma-separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.

Request Body

AccountPermissionProfiles

Responses

Code	Description	Reference
201	Successful response.	AccountPermissionProfiles
400	Error encountered.	errorDetails

Code

Description

Reference

201

Successful response.

AccountPermissionProfiles

400

Error encountered.

errorDetails

SDK Method

Accounts::createPermissionProfile

Definitions

accountRoleSettings


`allowAccountManagement`	string
`allowAccountManagementMetadata`	settingsMetadata
`allowApiAccess`	string
`allowApiAccessMetadata`	settingsMetadata
`allowApiAccessToAccount`	string
`allowApiAccessToAccountMetadata`	settingsMetadata
`allowApiSendingOnBehalfOfOthers`	string
`allowApiSendingOnBehalfOfOthersMetadata`	settingsMetadata
`allowApiSequentialSigning`	string
`allowApiSequentialSigningMetadata`	settingsMetadata
`allowBulkSending`	string
`allowBulkSendingMetadata`	settingsMetadata
`allowDocuSignDesktopClient`	string
`allowDocuSignDesktopClientMetadata`	settingsMetadata
`allowedAddressBookAccess`	string
`allowedAddressBookAccessMetadata`	settingsMetadata
`allowedTemplateAccess`	string
`allowedTemplateAccessMetadata`	settingsMetadata
`allowedToBeEnvelopeTransferRecipient`	string
`allowedToBeEnvelopeTransferRecipientMetadata`	settingsMetadata
`allowEnvelopeSending`	string
`allowEnvelopeSendingMetadata`	settingsMetadata
`allowESealRecipients`	string
`allowESealRecipientsMetadata`	settingsMetadata
`allowPowerFormsAdminToAccessAllPowerFormEnvelopes`	string
`allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata`	settingsMetadata
`allowSendersToSetRecipientEmailLanguage`	string
`allowSendersToSetRecipientEmailLanguageMetadata`	settingsMetadata
`allowSignerAttachments`	string
`allowSignerAttachmentsMetadata`	settingsMetadata
`allowSupplementalDocuments`	string
`allowSupplementalDocumentsMetadata`	settingsMetadata
`allowTaggingInSendAndCorrect`	string
`allowTaggingInSendAndCorrectMetadata`	settingsMetadata
`allowVaulting`	string
`allowVaultingMetadata`	settingsMetadata
`allowWetSigningOverride`	string
`allowWetSigningOverrideMetadata`	settingsMetadata
`canCreateWorkspaces`	string
`canCreateWorkspacesMetadata`	settingsMetadata
`disableDocumentUpload`	string
`disableDocumentUploadMetadata`	settingsMetadata
`disableOtherActions`	string
`disableOtherActionsMetadata`	settingsMetadata
`enableApiRequestLogging`	string
`enableApiRequestLoggingMetadata`	settingsMetadata
`enableRecipientViewingNotifications`	string
`enableRecipientViewingNotificationsMetadata`	settingsMetadata
`enableSequentialSigningInterface`	string
`enableSequentialSigningInterfaceMetadata`	settingsMetadata
`enableTransactionPointIntegration`	string
`enableTransactionPointIntegrationMetadata`	settingsMetadata
`powerFormRole`	string
`powerFormRoleMetadata`	settingsMetadata
`receiveCompletedSelfSignedDocumentsAsEmailLinks`	string
`receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata`	settingsMetadata
`supplementalDocumentsMustAccept`	string
`supplementalDocumentsMustAcceptMetadata`	settingsMetadata
`supplementalDocumentsMustRead`	string
`supplementalDocumentsMustReadMetadata`	settingsMetadata
`supplementalDocumentsMustView`	string
`supplementalDocumentsMustViewMetadata`	settingsMetadata
`useNewDocuSignExperienceInterface`	string
`useNewDocuSignExperienceInterfaceMetadata`	settingsMetadata
`useNewSendingInterface`	string
`useNewSendingInterfaceMetadata`	settingsMetadata
`vaultingMode`	string
`vaultingModeMetadata`	settingsMetadata

addressInformation_v2


`address1`	string	First Line of the address. Maximum length: 100 characters.
`address2`	string	Second Line of the address. Maximum length: 100 characters.
`city`	string
`country`	string	Specifies the country associated with the address.
`fax`	string
`phone`	string
`postalCode`	string
`stateOrProvince`	string	The state or province associated with the address.

errorDetails

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

errorCode

string

An error code associated with the error.

message

string

A short error message.

forgottenPasswordInformation

A complex element that has up to four Question/Answer pairs for forgotten password information.
`forgottenPasswordAnswer1`	string	The answer to the first forgotten password challenge question.
`forgottenPasswordAnswer2`	string	The answer to the second forgotten password challenge question.
`forgottenPasswordAnswer3`	string	The answer to the third forgotten password challenge question.
`forgottenPasswordAnswer4`	string	The answer to the fourth forgotten password challenge question.
`forgottenPasswordQuestion1`	string	The first challenge question presented to a user who has forgotten their password.
`forgottenPasswordQuestion2`	string	The second challenge question presented to a user who has forgotten their password.
`forgottenPasswordQuestion3`	string	The third challenge question presented to a user who has forgotten their password.
`forgottenPasswordQuestion4`	string	The fourth challenge question presented to a user who has forgotten their password.

group

Information about groups.
`errorDetails`	errorDetails
`groupId`	string	The DocuSign group ID for the group.
`groupName`	string	The name of the group.
`groupType`	string	The group type.
`permissionProfileId`	string	The ID of the permission profile associated with the group.
`users`	[userInfo]	List of users in the group.

nameValue


`errorDetails`	errorDetails
`name`	string	The name or key of a name/value pair.
`originalValue`	string	The initial value of the tab when it was sent to the recipient.
`value`	string	The value field of a name/value pair.

settingsMetadata


`is21CFRPart11`	string	When set to true, indicates that this module is enabled on the account.
`options`	[array]
`rights`	string
`uiHint`	string
`uiOrder`	string
`uiType`	string

userAccountManagementGranularInformation

Describes which account management capabilities a user has.
`canManageAccountSecuritySettings`	string
`canManageAccountSecuritySettingsMetadata`	settingsMetadata
`canManageAccountSettings`	string
`canManageAccountSettingsMetadata`	settingsMetadata
`canManageAdmins`	string	True if the user can manage admins.
`canManageAdminsMetadata`	settingsMetadata
`canManageGroups`	string	True if the user can manage groups.
`canManageGroupsMetadata`	settingsMetadata
`canManageReporting`	string
`canManageReportingMetadata`	settingsMetadata
`canManageSharing`	string
`canManageSharingMetadata`	settingsMetadata
`canManageSigningGroups`	string
`canManageSigningGroupsMetadata`	settingsMetadata
`canManageUsers`	string	True if the user can manage users.
`canManageUsersMetadata`	settingsMetadata

userInfo


`activationAccessCode`	string
`email`	string
`errorDetails`	errorDetails
`loginStatus`	string
`sendActivationEmail`	string
`uri`	string
`userId`	string	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes `user_id` query parameter is not implemented and should not be used.
`userName`	string
`userStatus`	string	Status of the user's account. One of: ActivationRequired ActivationSent Active Closed Disabled
`userType`	string

Users

User management
`accountManagementGranular`	userAccountManagementGranularInformation	Describes which account management capabilities a user has.
`activationAccessCode`	string	The activation code the new user must enter when activating their account.
`countryCode`	string
`createdDateTime`	string	Indicates the date and time the item was created.
`customSettings`	[nameValue]	The name/value pair information for the user custom setting.
`email`	string	The user's email address.
`enableConnectForUser`	string	Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false.
`errorDetails`	errorDetails
`firstName`	string	The user's first name. Maximum Length: 50 characters.
`forgottenPasswordInfo`	forgottenPasswordInformation	A complex element that has up to four Question/Answer pairs for forgotten password information.
`groupList`	[group]	A list of the group information for groups to add the user to. Group information can be found by calling [ML:GET group information]. The only required parameter is groupId. The parameters are: groupId - The DocuSign group ID for the group. groupName - The name of the group permissionProfileId - The ID of the permission profile associated with the group. groupType - The group type.
`homeAddress`	addressInformation_v2	The user's physical home address.
`initialsImageUri`	string	Contains the URI for an endpoint that you can use to retrieve the initials image.
`isAdmin`	string	Determines if the feature set is actively set as part of the plan.
`lastLogin`	string	The date-time when the user last logged on to the system.
`lastName`	string	The user's last name. Maximum Length: 50 characters.
`loginStatus`	string	Shows the current status of the user's password. Possible values are: password_reset password_active password_expired password_locked password_reset_failed
`middleName`	string	The user's middle name. Limit: 50 characters.
`password`	string
`passwordExpiration`	string	If password expiration is enabled, the date-time when the user's password expires.
`permissionProfileId`	string
`permissionProfileName`	string
`profileImageUri`	string
`sendActivationEmail`	string
`sendActivationOnInvalidLogin`	string	When set to true, specifies that an additional activation email is sent to the user if they fail a log on before activating their account.
`signatureImageUri`	string	Contains the URI for an endpoint that you can use to retrieve the signature image.
`subscribe`	string
`suffixName`	string	The suffix for the user's name, such as Jr, IV, PhD, etc. Limit: 50 characters.
`title`	string	Salutation for the user, such as Ms, Dr, Capt., etc. Limit: 10 characters.
`uri`	string
`userId`	string	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes `user_id` query parameter is not implemented and should not be used.
`userName`	string	The user's full name.
`userProfileLastModifiedDate`	string	The date-time when the user's profile was last modified.
`userSettings`	[nameValue]	The collection of settings that describes the actions a user can perform. See User Settings for a list of available settings.
`userStatus`	string	Status of the user's account. One of: ActivationRequired ActivationSent Active Closed Disabled
`userType`	string
`workAddress`	addressInformation_v2	The user's physical work address.

AccountPermissionProfiles


`modifiedByUsername`	string
`modifiedDateTime`	string
`permissionProfileId`	string
`permissionProfileName`	string
`settings`	accountRoleSettings
`userCount`	string
`users`	[Users]

Examples

Generic JSON Request/Response

Request

{
  "permissionProfileId": "sample string 1",
  "permissionProfileName": "sample string 2",
  "users": [
    {
      "userName": "sample string 1",
      "userId": "sample string 2",
      "userType": "sample string 3",
      "isAdmin": "sample string 4",
      "userStatus": "sample string 5",
      "uri": "sample string 6",
      "email": "sample string 7",
      "password": "sample string 8",
      "title": "sample string 9",
      "createdDateTime": "sample string 10",
      "firstName": "sample string 11",
      "middleName": "sample string 12",
      "lastName": "sample string 13",
      "suffixName": "sample string 14",
      "permissionProfileId": "sample string 15",
      "permissionProfileName": "sample string 16",
      "countryCode": "sample string 17",
      "subscribe": "sample string 18",
      "userSettings": [
        {}
      ],
      "accountManagementGranular": {
        "canManageUsers": "sample string 1",
        "canManageAdmins": "sample string 2",
        "canManageGroups": "sample string 3",
        "canManageSharing": "sample string 4",
        "canManageUsersMetadata": {
          "rights": "sample string 1",
          "uiHint": "sample string 2",
          "uiType": "sample string 3",
          "uiOrder": "sample string 4",
          "is21CFRPart11": "sample string 5",
          "options": [
            "sample string 1"
          ]
        },
        "canManageAdminsMetadata": {},
        "canManageGroupsMetadata": {},
        "canManageSharingMetadata": {}
      },
      "sendActivationOnInvalidLogin": "sample string 19",
      "activationAccessCode": "sample string 20",
      "enableConnectForUser": "sample string 21",
      "forgottenPasswordInfo": {
        "forgottenPasswordQuestion1": "sample string 1",
        "forgottenPasswordAnswer1": "sample string 2",
        "forgottenPasswordQuestion2": "sample string 3",
        "forgottenPasswordAnswer2": "sample string 4",
        "forgottenPasswordQuestion3": "sample string 5",
        "forgottenPasswordAnswer3": "sample string 6",
        "forgottenPasswordQuestion4": "sample string 7",
        "forgottenPasswordAnswer4": "sample string 8"
      },
      "groupList": [
        {
          "groupId": "sample string 1",
          "groupName": "sample string 2",
          "permissionProfileId": "sample string 3",
          "groupType": "sample string 4",
          "users": [
            {
              "userName": "sample string 1",
              "userId": "sample string 2",
              "email": "sample string 3",
              "userType": "sample string 4",
              "userStatus": "sample string 5",
              "uri": "sample string 6",
              "loginStatus": "sample string 7",
              "sendActivationEmail": "sample string 8",
              "activationAccessCode": "sample string 9"
            }
          ]
        }
      ],
      "workAddress": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "city": "sample string 3",
        "stateOrProvince": "sample string 4",
        "postalCode": "sample string 5",
        "phone": "sample string 6",
        "fax": "sample string 7",
        "country": "sample string 8"
      },
      "homeAddress": {},
      "loginStatus": "sample string 22",
      "passwordExpiration": "sample string 23",
      "lastLogin": "sample string 24",
      "sendActivationEmail": "sample string 25",
      "customSettings": [
        {}
      ],
      "profileImageUri": "sample string 26",
      "userProfileLastModifiedDate": "sample string 27",
      "signatureImageUri": "sample string 28",
      "initialsImageUri": "sample string 29",
      "jobTitle": "sample string 30"
    }
  ],
  "modifiedDateTime": "sample string 3",
  "modifiedByUsername": "sample string 4",
  "userCount": "sample string 5",
  "settings": {
    "allowAccountManagement": "sample string 1",
    "useNewDocuSignExperienceInterface": "sample string 2",
    "canCreateWorkspaces": "sample string 3",
    "allowBulkSending": "sample string 4",
    "allowEnvelopeSending": "sample string 5",
    "allowESealRecipients": "sample string 6",
    "allowSignerAttachments": "sample string 7",
    "allowTaggingInSendAndCorrect": "sample string 8",
    "allowWetSigningOverride": "sample string 9",
    "allowedAddressBookAccess": "sample string 10",
    "allowedTemplateAccess": "sample string 11",
    "enableRecipientViewingNotifications": "sample string 12",
    "enableSequentialSigningInterface": "sample string 13",
    "receiveCompletedSelfSignedDocumentsAsEmailLinks": "sample string 14",
    "useNewSendingInterface": "sample string 15",
    "allowSupplementalDocuments": "sample string 16",
    "supplementalDocumentsMustView": "sample string 17",
    "supplementalDocumentsMustAccept": "sample string 18",
    "supplementalDocumentsMustRead": "sample string 19",
    "disableDocumentUpload": "sample string 20",
    "disableOtherActions": "sample string 21",
    "allowApiAccess": "sample string 22",
    "allowApiAccessToAccount": "sample string 23",
    "allowApiSendingOnBehalfOfOthers": "sample string 24",
    "allowApiSequentialSigning": "sample string 25",
    "enableApiRequestLogging": "sample string 26",
    "allowDocuSignDesktopClient": "sample string 27",
    "allowSendersToSetRecipientEmailLanguage": "sample string 28",
    "allowVaulting": "sample string 29",
    "allowedToBeEnvelopeTransferRecipient": "sample string 30",
    "enableTransactionPointIntegration": "sample string 31",
    "powerFormRole": "sample string 32",
    "allowPowerFormsAdminToAccessAllPowerFormEnvelopes": "sample string 33",
    "vaultingMode": "sample string 34",
    "allowAccountManagementMetadata": {},
    "useNewDocuSignExperienceInterfaceMetadata": {},
    "canCreateWorkspacesMetadata": {},
    "allowBulkSendingMetadata": {},
    "allowEnvelopeSendingMetadata": {},
    "allowESealRecipientsMetadata": {},
    "allowSignerAttachmentsMetadata": {},
    "allowTaggingInSendAndCorrectMetadata": {},
    "allowWetSigningOverrideMetadata": {},
    "allowedAddressBookAccessMetadata": {},
    "allowedTemplateAccessMetadata": {},
    "enableRecipientViewingNotificationsMetadata": {},
    "enableSequentialSigningInterfaceMetadata": {},
    "receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata": {},
    "useNewSendingInterfaceMetadata": {},
    "allowSupplementalDocumentsMetadata": {},
    "supplementalDocumentsMustViewMetadata": {},
    "supplementalDocumentsMustAcceptMetadata": {},
    "supplementalDocumentsMustReadMetadata": {},
    "disableDocumentUploadMetadata": {},
    "disableOtherActionsMetadata": {},
    "allowApiAccessMetadata": {},
    "allowApiAccessToAccountMetadata": {},
    "allowApiSendingOnBehalfOfOthersMetadata": {},
    "allowApiSequentialSigningMetadata": {},
    "enableApiRequestLoggingMetadata": {},
    "allowDocuSignDesktopClientMetadata": {},
    "allowSendersToSetRecipientEmailLanguageMetadata": {},
    "allowVaultingMetadata": {},
    "allowedToBeEnvelopeTransferRecipientMetadata": {},
    "enableTransactionPointIntegrationMetadata": {},
    "powerFormRoleMetadata": {},
    "allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata": {},
    "vaultingModeMetadata": {}
  }
}

Response

{
  "permissionProfileId": "sample string 1",
  "permissionProfileName": "sample string 2",
  "users": [
    {
      "userName": "sample string 1",
      "userId": "sample string 2",
      "userType": "sample string 3",
      "isAdmin": "sample string 4",
      "userStatus": "sample string 5",
      "uri": "sample string 6",
      "email": "sample string 7",
      "password": "sample string 8",
      "title": "sample string 9",
      "createdDateTime": "sample string 10",
      "firstName": "sample string 11",
      "middleName": "sample string 12",
      "lastName": "sample string 13",
      "suffixName": "sample string 14",
      "permissionProfileId": "sample string 15",
      "permissionProfileName": "sample string 16",
      "countryCode": "sample string 17",
      "subscribe": "sample string 18",
      "userSettings": [
        {}
      ],
      "accountManagementGranular": {
        "canManageUsers": "sample string 1",
        "canManageAdmins": "sample string 2",
        "canManageGroups": "sample string 3",
        "canManageSharing": "sample string 4",
        "canManageUsersMetadata": {
          "rights": "sample string 1",
          "uiHint": "sample string 2",
          "uiType": "sample string 3",
          "uiOrder": "sample string 4",
          "is21CFRPart11": "sample string 5",
          "options": [
            "sample string 1"
          ]
        },
        "canManageAdminsMetadata": {},
        "canManageGroupsMetadata": {},
        "canManageSharingMetadata": {}
      },
      "sendActivationOnInvalidLogin": "sample string 19",
      "activationAccessCode": "sample string 20",
      "enableConnectForUser": "sample string 21",
      "forgottenPasswordInfo": {
        "forgottenPasswordQuestion1": "sample string 1",
        "forgottenPasswordAnswer1": "sample string 2",
        "forgottenPasswordQuestion2": "sample string 3",
        "forgottenPasswordAnswer2": "sample string 4",
        "forgottenPasswordQuestion3": "sample string 5",
        "forgottenPasswordAnswer3": "sample string 6",
        "forgottenPasswordQuestion4": "sample string 7",
        "forgottenPasswordAnswer4": "sample string 8"
      },
      "groupList": [
        {
          "groupId": "sample string 1",
          "groupName": "sample string 2",
          "permissionProfileId": "sample string 3",
          "groupType": "sample string 4",
          "users": [
            {
              "userName": "sample string 1",
              "userId": "sample string 2",
              "email": "sample string 3",
              "userType": "sample string 4",
              "userStatus": "sample string 5",
              "uri": "sample string 6",
              "loginStatus": "sample string 7",
              "sendActivationEmail": "sample string 8",
              "activationAccessCode": "sample string 9",
              "errorDetails": {
                "errorCode": "sample string 1",
                "message": "sample string 2"
              }
            }
          ],
          "errorDetails": {
            "errorCode": "SUCCESS",
            "message": ""
          }
        }
      ],
      "workAddress": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "city": "sample string 3",
        "stateOrProvince": "sample string 4",
        "postalCode": "sample string 5",
        "phone": "sample string 6",
        "fax": "sample string 7",
        "country": "sample string 8"
      },
      "homeAddress": {},
      "loginStatus": "sample string 22",
      "passwordExpiration": "sample string 23",
      "lastLogin": "sample string 24",
      "sendActivationEmail": "sample string 25",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "customSettings": [
        {}
      ],
      "profileImageUri": "sample string 26",
      "userProfileLastModifiedDate": "sample string 27",
      "signatureImageUri": "sample string 28",
      "initialsImageUri": "sample string 29",
      "jobTitle": "sample string 30"
    }
  ],
  "modifiedDateTime": "sample string 3",
  "modifiedByUsername": "sample string 4",
  "userCount": "sample string 5",
  "settings": {
    "allowAccountManagement": "sample string 1",
    "useNewDocuSignExperienceInterface": "sample string 2",
    "canCreateWorkspaces": "sample string 3",
    "allowBulkSending": "sample string 4",
    "allowEnvelopeSending": "sample string 5",
    "allowESealRecipients": "sample string 6",
    "allowSignerAttachments": "sample string 7",
    "allowTaggingInSendAndCorrect": "sample string 8",
    "allowWetSigningOverride": "sample string 9",
    "allowedAddressBookAccess": "sample string 10",
    "allowedTemplateAccess": "sample string 11",
    "enableRecipientViewingNotifications": "sample string 12",
    "enableSequentialSigningInterface": "sample string 13",
    "receiveCompletedSelfSignedDocumentsAsEmailLinks": "sample string 14",
    "useNewSendingInterface": "sample string 15",
    "allowSupplementalDocuments": "sample string 16",
    "supplementalDocumentsMustView": "sample string 17",
    "supplementalDocumentsMustAccept": "sample string 18",
    "supplementalDocumentsMustRead": "sample string 19",
    "disableDocumentUpload": "sample string 20",
    "disableOtherActions": "sample string 21",
    "allowApiAccess": "sample string 22",
    "allowApiAccessToAccount": "sample string 23",
    "allowApiSendingOnBehalfOfOthers": "sample string 24",
    "allowApiSequentialSigning": "sample string 25",
    "enableApiRequestLogging": "sample string 26",
    "allowDocuSignDesktopClient": "sample string 27",
    "allowSendersToSetRecipientEmailLanguage": "sample string 28",
    "allowVaulting": "sample string 29",
    "allowedToBeEnvelopeTransferRecipient": "sample string 30",
    "enableTransactionPointIntegration": "sample string 31",
    "powerFormRole": "sample string 32",
    "allowPowerFormsAdminToAccessAllPowerFormEnvelopes": "sample string 33",
    "vaultingMode": "sample string 34",
    "allowAccountManagementMetadata": {},
    "useNewDocuSignExperienceInterfaceMetadata": {},
    "canCreateWorkspacesMetadata": {},
    "allowBulkSendingMetadata": {},
    "allowEnvelopeSendingMetadata": {},
    "allowESealRecipientsMetadata": {},
    "allowSignerAttachmentsMetadata": {},
    "allowTaggingInSendAndCorrectMetadata": {},
    "allowWetSigningOverrideMetadata": {},
    "allowedAddressBookAccessMetadata": {},
    "allowedTemplateAccessMetadata": {},
    "enableRecipientViewingNotificationsMetadata": {},
    "enableSequentialSigningInterfaceMetadata": {},
    "receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata": {},
    "useNewSendingInterfaceMetadata": {},
    "allowSupplementalDocumentsMetadata": {},
    "supplementalDocumentsMustViewMetadata": {},
    "supplementalDocumentsMustAcceptMetadata": {},
    "supplementalDocumentsMustReadMetadata": {},
    "disableDocumentUploadMetadata": {},
    "disableOtherActionsMetadata": {},
    "allowApiAccessMetadata": {},
    "allowApiAccessToAccountMetadata": {},
    "allowApiSendingOnBehalfOfOthersMetadata": {},
    "allowApiSequentialSigningMetadata": {},
    "enableApiRequestLoggingMetadata": {},
    "allowDocuSignDesktopClientMetadata": {},
    "allowSendersToSetRecipientEmailLanguageMetadata": {},
    "allowVaultingMetadata": {},
    "allowedToBeEnvelopeTransferRecipientMetadata": {},
    "enableTransactionPointIntegrationMetadata": {},
    "powerFormRoleMetadata": {},
    "allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata": {},
    "vaultingModeMetadata": {}
  }
}

Generic XML Request/Response

Request

<permissionProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <modifiedByUsername>sample string 4</modifiedByUsername>
  <modifiedDateTime>sample string 3</modifiedDateTime>
  <permissionProfileId>sample string 1</permissionProfileId>
  <permissionProfileName>sample string 2</permissionProfileName>
  <settings>
    <allowAccountManagement>sample string 1</allowAccountManagement>
    <allowAccountManagementMetadata />
    <allowApiAccess>sample string 22</allowApiAccess>
    <allowApiAccessMetadata />
    <allowApiAccessToAccount>sample string 23</allowApiAccessToAccount>
    <allowApiAccessToAccountMetadata />
    <allowApiSendingOnBehalfOfOthers>sample string 24</allowApiSendingOnBehalfOfOthers>
    <allowApiSendingOnBehalfOfOthersMetadata />
    <allowApiSequentialSigning>sample string 25</allowApiSequentialSigning>
    <allowApiSequentialSigningMetadata />
    <allowBulkSending>sample string 4</allowBulkSending>
    <allowBulkSendingMetadata />
    <allowDocuSignDesktopClient>sample string 27</allowDocuSignDesktopClient>
    <allowDocuSignDesktopClientMetadata />
    <allowESealRecipients>sample string 6</allowESealRecipients>
    <allowESealRecipientsMetadata />
    <allowEnvelopeSending>sample string 5</allowEnvelopeSending>
    <allowEnvelopeSendingMetadata />
    <allowPowerFormsAdminToAccessAllPowerFormEnvelopes>sample string 33</allowPowerFormsAdminToAccessAllPowerFormEnvelopes>
    <allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata />
    <allowSendersToSetRecipientEmailLanguage>sample string 28</allowSendersToSetRecipientEmailLanguage>
    <allowSendersToSetRecipientEmailLanguageMetadata />
    <allowSignerAttachments>sample string 7</allowSignerAttachments>
    <allowSignerAttachmentsMetadata />
    <allowSupplementalDocuments>sample string 16</allowSupplementalDocuments>
    <allowSupplementalDocumentsMetadata />
    <allowTaggingInSendAndCorrect>sample string 8</allowTaggingInSendAndCorrect>
    <allowTaggingInSendAndCorrectMetadata />
    <allowVaulting>sample string 29</allowVaulting>
    <allowVaultingMetadata />
    <allowWetSigningOverride>sample string 9</allowWetSigningOverride>
    <allowWetSigningOverrideMetadata />
    <allowedAddressBookAccess>sample string 10</allowedAddressBookAccess>
    <allowedAddressBookAccessMetadata />
    <allowedTemplateAccess>sample string 11</allowedTemplateAccess>
    <allowedTemplateAccessMetadata />
    <allowedToBeEnvelopeTransferRecipient>sample string 30</allowedToBeEnvelopeTransferRecipient>
    <allowedToBeEnvelopeTransferRecipientMetadata />
    <canCreateWorkspaces>sample string 3</canCreateWorkspaces>
    <canCreateWorkspacesMetadata />
    <disableDocumentUpload>sample string 20</disableDocumentUpload>
    <disableDocumentUploadMetadata />
    <disableOtherActions>sample string 21</disableOtherActions>
    <disableOtherActionsMetadata />
    <enableApiRequestLogging>sample string 26</enableApiRequestLogging>
    <enableApiRequestLoggingMetadata />
    <enableRecipientViewingNotifications>sample string 12</enableRecipientViewingNotifications>
    <enableRecipientViewingNotificationsMetadata />
    <enableSequentialSigningInterface>sample string 13</enableSequentialSigningInterface>
    <enableSequentialSigningInterfaceMetadata />
    <enableTransactionPointIntegration>sample string 31</enableTransactionPointIntegration>
    <enableTransactionPointIntegrationMetadata />
    <powerFormRole>sample string 32</powerFormRole>
    <powerFormRoleMetadata />
    <receiveCompletedSelfSignedDocumentsAsEmailLinks>sample string 14</receiveCompletedSelfSignedDocumentsAsEmailLinks>
    <receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata />
    <supplementalDocumentsMustAccept>sample string 18</supplementalDocumentsMustAccept>
    <supplementalDocumentsMustAcceptMetadata />
    <supplementalDocumentsMustRead>sample string 19</supplementalDocumentsMustRead>
    <supplementalDocumentsMustReadMetadata />
    <supplementalDocumentsMustView>sample string 17</supplementalDocumentsMustView>
    <supplementalDocumentsMustViewMetadata />
    <useNewDocuSignExperienceInterface>sample string 2</useNewDocuSignExperienceInterface>
    <useNewDocuSignExperienceInterfaceMetadata />
    <useNewSendingInterface>sample string 15</useNewSendingInterface>
    <useNewSendingInterfaceMetadata />
    <vaultingMode>sample string 34</vaultingMode>
    <vaultingModeMetadata />
  </settings>
  <userCount>sample string 5</userCount>
  <users>
    <userInformation>
      <accountManagementGranular>
        <canManageAdmins>sample string 2</canManageAdmins>
        <canManageAdminsMetadata />
        <canManageGroups>sample string 3</canManageGroups>
        <canManageGroupsMetadata />
        <canManageSharing>sample string 4</canManageSharing>
        <canManageSharingMetadata />
        <canManageUsers>sample string 1</canManageUsers>
        <canManageUsersMetadata>
          <is21CFRPart11>sample string 5</is21CFRPart11>
          <options>
            <string>sample string 1</string>
          </options>
          <rights>sample string 1</rights>
          <uiHint>sample string 2</uiHint>
          <uiOrder>sample string 4</uiOrder>
          <uiType>sample string 3</uiType>
        </canManageUsersMetadata>
      </accountManagementGranular>
      <activationAccessCode>sample string 20</activationAccessCode>
      <countryCode>sample string 17</countryCode>
      <createdDateTime>sample string 10</createdDateTime>
      <customSettings>
        <nameValue />
      </customSettings>
      <email>sample string 7</email>
      <enableConnectForUser>sample string 21</enableConnectForUser>
      <firstName>sample string 11</firstName>
      <forgottenPasswordInfo>
        <forgottenPasswordAnswer1>sample string 2</forgottenPasswordAnswer1>
        <forgottenPasswordAnswer2>sample string 4</forgottenPasswordAnswer2>
        <forgottenPasswordAnswer3>sample string 6</forgottenPasswordAnswer3>
        <forgottenPasswordAnswer4>sample string 8</forgottenPasswordAnswer4>
        <forgottenPasswordQuestion1>sample string 1</forgottenPasswordQuestion1>
        <forgottenPasswordQuestion2>sample string 3</forgottenPasswordQuestion2>
        <forgottenPasswordQuestion3>sample string 5</forgottenPasswordQuestion3>
        <forgottenPasswordQuestion4>sample string 7</forgottenPasswordQuestion4>
      </forgottenPasswordInfo>
      <groupList>
        <group>
          <groupId>sample string 1</groupId>
          <groupName>sample string 2</groupName>
          <groupType>sample string 4</groupType>
          <permissionProfileId>sample string 3</permissionProfileId>
          <users>
            <userInfo>
              <activationAccessCode>sample string 9</activationAccessCode>
              <email>sample string 3</email>
              <loginStatus>sample string 7</loginStatus>
              <sendActivationEmail>sample string 8</sendActivationEmail>
              <uri>sample string 6</uri>
              <userId>sample string 2</userId>
              <userName>sample string 1</userName>
              <userStatus>sample string 5</userStatus>
              <userType>sample string 4</userType>
            </userInfo>
          </users>
        </group>
      </groupList>
      <homeAddress />
      <initialsImageUri>sample string 29</initialsImageUri>
      <isAdmin>sample string 4</isAdmin>
      <jobTitle>sample string 30</jobTitle>
      <lastLogin>sample string 24</lastLogin>
      <lastName>sample string 13</lastName>
      <loginStatus>sample string 22</loginStatus>
      <middleName>sample string 12</middleName>
      <password>sample string 8</password>
      <passwordExpiration>sample string 23</passwordExpiration>
      <permissionProfileId>sample string 15</permissionProfileId>
      <permissionProfileName>sample string 16</permissionProfileName>
      <profileImageUri>sample string 26</profileImageUri>
      <sendActivationEmail>sample string 25</sendActivationEmail>
      <sendActivationOnInvalidLogin>sample string 19</sendActivationOnInvalidLogin>
      <signatureImageUri>sample string 28</signatureImageUri>
      <subscribe>sample string 18</subscribe>
      <suffixName>sample string 14</suffixName>
      <title>sample string 9</title>
      <uri>sample string 6</uri>
      <userId>sample string 2</userId>
      <userName>sample string 1</userName>
      <userProfileLastModifiedDate>sample string 27</userProfileLastModifiedDate>
      <userSettings>
        <nameValue />
      </userSettings>
      <userStatus>sample string 5</userStatus>
      <userType>sample string 3</userType>
      <workAddress>
        <address1>sample string 1</address1>
        <address2>sample string 2</address2>
        <city>sample string 3</city>
        <country>sample string 8</country>
        <fax>sample string 7</fax>
        <phone>sample string 6</phone>
        <postalCode>sample string 5</postalCode>
        <stateOrProvince>sample string 4</stateOrProvince>
      </workAddress>
    </userInformation>
  </users>
</permissionProfile>

Response

<permissionProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <modifiedByUsername>sample string 4</modifiedByUsername>
  <modifiedDateTime>sample string 3</modifiedDateTime>
  <permissionProfileId>sample string 1</permissionProfileId>
  <permissionProfileName>sample string 2</permissionProfileName>
  <settings>
    <allowAccountManagement>sample string 1</allowAccountManagement>
    <allowAccountManagementMetadata />
    <allowApiAccess>sample string 22</allowApiAccess>
    <allowApiAccessMetadata />
    <allowApiAccessToAccount>sample string 23</allowApiAccessToAccount>
    <allowApiAccessToAccountMetadata />
    <allowApiSendingOnBehalfOfOthers>sample string 24</allowApiSendingOnBehalfOfOthers>
    <allowApiSendingOnBehalfOfOthersMetadata />
    <allowApiSequentialSigning>sample string 25</allowApiSequentialSigning>
    <allowApiSequentialSigningMetadata />
    <allowBulkSending>sample string 4</allowBulkSending>
    <allowBulkSendingMetadata />
    <allowDocuSignDesktopClient>sample string 27</allowDocuSignDesktopClient>
    <allowDocuSignDesktopClientMetadata />
    <allowESealRecipients>sample string 6</allowESealRecipients>
    <allowESealRecipientsMetadata />
    <allowEnvelopeSending>sample string 5</allowEnvelopeSending>
    <allowEnvelopeSendingMetadata />
    <allowPowerFormsAdminToAccessAllPowerFormEnvelopes>sample string 33</allowPowerFormsAdminToAccessAllPowerFormEnvelopes>
    <allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata />
    <allowSendersToSetRecipientEmailLanguage>sample string 28</allowSendersToSetRecipientEmailLanguage>
    <allowSendersToSetRecipientEmailLanguageMetadata />
    <allowSignerAttachments>sample string 7</allowSignerAttachments>
    <allowSignerAttachmentsMetadata />
    <allowSupplementalDocuments>sample string 16</allowSupplementalDocuments>
    <allowSupplementalDocumentsMetadata />
    <allowTaggingInSendAndCorrect>sample string 8</allowTaggingInSendAndCorrect>
    <allowTaggingInSendAndCorrectMetadata />
    <allowVaulting>sample string 29</allowVaulting>
    <allowVaultingMetadata />
    <allowWetSigningOverride>sample string 9</allowWetSigningOverride>
    <allowWetSigningOverrideMetadata />
    <allowedAddressBookAccess>sample string 10</allowedAddressBookAccess>
    <allowedAddressBookAccessMetadata />
    <allowedTemplateAccess>sample string 11</allowedTemplateAccess>
    <allowedTemplateAccessMetadata />
    <allowedToBeEnvelopeTransferRecipient>sample string 30</allowedToBeEnvelopeTransferRecipient>
    <allowedToBeEnvelopeTransferRecipientMetadata />
    <canCreateWorkspaces>sample string 3</canCreateWorkspaces>
    <canCreateWorkspacesMetadata />
    <disableDocumentUpload>sample string 20</disableDocumentUpload>
    <disableDocumentUploadMetadata />
    <disableOtherActions>sample string 21</disableOtherActions>
    <disableOtherActionsMetadata />
    <enableApiRequestLogging>sample string 26</enableApiRequestLogging>
    <enableApiRequestLoggingMetadata />
    <enableRecipientViewingNotifications>sample string 12</enableRecipientViewingNotifications>
    <enableRecipientViewingNotificationsMetadata />
    <enableSequentialSigningInterface>sample string 13</enableSequentialSigningInterface>
    <enableSequentialSigningInterfaceMetadata />
    <enableTransactionPointIntegration>sample string 31</enableTransactionPointIntegration>
    <enableTransactionPointIntegrationMetadata />
    <powerFormRole>sample string 32</powerFormRole>
    <powerFormRoleMetadata />
    <receiveCompletedSelfSignedDocumentsAsEmailLinks>sample string 14</receiveCompletedSelfSignedDocumentsAsEmailLinks>
    <receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata />
    <supplementalDocumentsMustAccept>sample string 18</supplementalDocumentsMustAccept>
    <supplementalDocumentsMustAcceptMetadata />
    <supplementalDocumentsMustRead>sample string 19</supplementalDocumentsMustRead>
    <supplementalDocumentsMustReadMetadata />
    <supplementalDocumentsMustView>sample string 17</supplementalDocumentsMustView>
    <supplementalDocumentsMustViewMetadata />
    <useNewDocuSignExperienceInterface>sample string 2</useNewDocuSignExperienceInterface>
    <useNewDocuSignExperienceInterfaceMetadata />
    <useNewSendingInterface>sample string 15</useNewSendingInterface>
    <useNewSendingInterfaceMetadata />
    <vaultingMode>sample string 34</vaultingMode>
    <vaultingModeMetadata />
  </settings>
  <userCount>sample string 5</userCount>
  <users>
    <userInformation>
      <accountManagementGranular>
        <canManageAdmins>sample string 2</canManageAdmins>
        <canManageAdminsMetadata />
        <canManageGroups>sample string 3</canManageGroups>
        <canManageGroupsMetadata />
        <canManageSharing>sample string 4</canManageSharing>
        <canManageSharingMetadata />
        <canManageUsers>sample string 1</canManageUsers>
        <canManageUsersMetadata>
          <is21CFRPart11>sample string 5</is21CFRPart11>
          <options>
            <string>sample string 1</string>
          </options>
          <rights>sample string 1</rights>
          <uiHint>sample string 2</uiHint>
          <uiOrder>sample string 4</uiOrder>
          <uiType>sample string 3</uiType>
        </canManageUsersMetadata>
      </accountManagementGranular>
      <activationAccessCode>sample string 20</activationAccessCode>
      <countryCode>sample string 17</countryCode>
      <createdDateTime>sample string 10</createdDateTime>
      <customSettings>
        <nameValue />
      </customSettings>
      <email>sample string 7</email>
      <enableConnectForUser>sample string 21</enableConnectForUser>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <firstName>sample string 11</firstName>
      <forgottenPasswordInfo>
        <forgottenPasswordAnswer1>sample string 2</forgottenPasswordAnswer1>
        <forgottenPasswordAnswer2>sample string 4</forgottenPasswordAnswer2>
        <forgottenPasswordAnswer3>sample string 6</forgottenPasswordAnswer3>
        <forgottenPasswordAnswer4>sample string 8</forgottenPasswordAnswer4>
        <forgottenPasswordQuestion1>sample string 1</forgottenPasswordQuestion1>
        <forgottenPasswordQuestion2>sample string 3</forgottenPasswordQuestion2>
        <forgottenPasswordQuestion3>sample string 5</forgottenPasswordQuestion3>
        <forgottenPasswordQuestion4>sample string 7</forgottenPasswordQuestion4>
      </forgottenPasswordInfo>
      <groupList>
        <group>
          <errorDetails>
            <errorCode>SUCCESS</errorCode>
            <message></message>
          </errorDetails>
          <groupId>sample string 1</groupId>
          <groupName>sample string 2</groupName>
          <groupType>sample string 4</groupType>
          <permissionProfileId>sample string 3</permissionProfileId>
          <users>
            <userInfo>
              <activationAccessCode>sample string 9</activationAccessCode>
              <email>sample string 3</email>
              <errorDetails>
                <errorCode>sample string 1</errorCode>
                <message>sample string 2</message>
              </errorDetails>
              <loginStatus>sample string 7</loginStatus>
              <sendActivationEmail>sample string 8</sendActivationEmail>
              <uri>sample string 6</uri>
              <userId>sample string 2</userId>
              <userName>sample string 1</userName>
              <userStatus>sample string 5</userStatus>
              <userType>sample string 4</userType>
            </userInfo>
          </users>
        </group>
      </groupList>
      <homeAddress />
      <initialsImageUri>sample string 29</initialsImageUri>
      <isAdmin>sample string 4</isAdmin>
      <jobTitle>sample string 30</jobTitle>
      <lastLogin>sample string 24</lastLogin>
      <lastName>sample string 13</lastName>
      <loginStatus>sample string 22</loginStatus>
      <middleName>sample string 12</middleName>
      <password>sample string 8</password>
      <passwordExpiration>sample string 23</passwordExpiration>
      <permissionProfileId>sample string 15</permissionProfileId>
      <permissionProfileName>sample string 16</permissionProfileName>
      <profileImageUri>sample string 26</profileImageUri>
      <sendActivationEmail>sample string 25</sendActivationEmail>
      <sendActivationOnInvalidLogin>sample string 19</sendActivationOnInvalidLogin>
      <signatureImageUri>sample string 28</signatureImageUri>
      <subscribe>sample string 18</subscribe>
      <suffixName>sample string 14</suffixName>
      <title>sample string 9</title>
      <uri>sample string 6</uri>
      <userId>sample string 2</userId>
      <userName>sample string 1</userName>
      <userProfileLastModifiedDate>sample string 27</userProfileLastModifiedDate>
      <userSettings>
        <nameValue />
      </userSettings>
      <userStatus>sample string 5</userStatus>
      <userType>sample string 3</userType>
      <workAddress>
        <address1>sample string 1</address1>
        <address2>sample string 2</address2>
        <city>sample string 3</city>
        <country>sample string 8</country>
        <fax>sample string 7</fax>
        <phone>sample string 6</phone>
        <postalCode>sample string 5</postalCode>
        <stateOrProvince>sample string 4</stateOrProvince>
      </workAddress>
    </userInformation>
  </users>
</permissionProfile>