Skip to content

DocuSign: Gets a list of permission profiles

DocuSign esignature.esignaturePermissionProfilesGetPermissionProfiles: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_permissionprofiles_getpermissionprofiles

Provider route: GET /restapi/v2.1/accounts/{accountId}/permission_profiles. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignaturePermissionProfilesGetPermissionProfiles"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignaturePermissionProfilesGetPermissionProfiles(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_permission_profiles_get_permission_profiles(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.includestringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets a list of permission profiles — response body

Referenced models: Gets a list of permission profiles — response body

11 more schemas are linked from the tables above, on the schema pages.

Gets a list of permission profiles — response body
FieldTypePresenceDescription and constraints
$objectRootContains details about the permission profiles associated with an account.
permissionProfilesarrayOptionalA complex type containing a collection of permission profiles.
permissionProfiles[]ModelEach itemExpand Returns a permission profile for an account — response body

Referenced models: Returns a permission profile for an account — response body

Returns a permission profile for an account — response body
FieldTypePresenceDescription and constraints
$objectRootThis object defines the account permissions for a profile that you can apply to a group of users.
modifiedByUsernamestringOptionalThe username of the user who last modified the permission profile.
modifiedDateTimestringOptionalThe date and time when the permission profile was last modified.
permissionProfileIdstringOptionalThe ID of the permission profile.

Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/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.
permissionProfileNamestringOptionalThe name of the account permission profile.

Example: `Account Administrator`
settingsModelOptionalExpand Returns a permission profile for an account — response body — settings
This object specifies the permissions that are associated with the account permission profile.
userCountstringOptionalThe total number of users in the group associated with the account permission profile.
usersarrayOptionalA list of user objects containing information about the users who are associated with the account permission profile.
users[]ModelEach itemExpand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body

Referenced models: Returns a permission profile for an account — response body — settings, Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body

Returns a permission profile for an account — response body — settings account Management Granular
FieldTypePresenceDescription and constraints
$objectRoot
allowManageAccountSecuritySettingsstringOptional
allowManageAccountSecuritySettingsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageAccountSettingsstringOptional
allowManageAccountSettingsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageAdminsstringOptional
allowManageAdminsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageConnectstringOptional
allowManageConnectMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageDocumentRetentionstringOptional
allowManageDocumentRetentionMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageEnvelopeTransferstringOptional
allowManageEnvelopeTransferMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageGroupsButNotUsersstringOptional
allowManageGroupsButNotUsersMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageJointAgreementsstringOptional
allowManageJointAgreementsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageReportingstringOptional
allowManageReportingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageSharingstringOptional
allowManageSharingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageSigningGroupsstringOptional
allowManageSigningGroupsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageStampsstringOptional
allowManageStampsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowManageUsersstringOptional
allowManageUsersMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowViewUsersstringOptional

Referenced models: Gets the user account settings for a specified user — response body — locale Metadata

Gets the user account settings for a specified user — response body — locale Metadata
FieldTypePresenceDescription and constraints
$objectRootMetadata that indicates whether a property is editable and describes setting-specific options.
is21CFRPart11stringOptionalWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
optionsarrayOptionalAn array of option strings supported by this setting.
options[]stringEach item
rightsstringOptionalIndicates whether the property is editable. Valid values are:

- `editable`
- `read_only`
uiHintstringOptionalReserved for Docusign.
uiOrderstringOptionalReserved for Docusign.
uiTypestringOptionalReserved for Docusign.
Get credit card information — response body — address
FieldTypePresenceDescription and constraints
$objectRootContains address information.
address1stringOptionalThe first line of the user's address.
Maximum length: 100 characters.
address2stringOptionalThe second line of the user's address.
Maximum length: 100 characters.
citystringOptionalThe user's city. Maximum length: 40 characters.
countrystringOptionalThe user's country. Maximum length: 50 characters.
faxstringOptionalA fax number associated with the address, if one is available.
phonestringOptionalA phone number associated with the address.
postalCodestringOptionalThe user's postal code. Maximum length: 20 characters.
stateOrProvincestringOptionalThe user's state or province. Maximum length: 40 characters.
zipPlus4stringOptional
Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — connect Configurations item
FieldTypePresenceDescription and constraints
$objectRoot
configurationtypestringOptionalThe type of custom Connect configuration being accessed.
connectIdstringOptionalThe ID of the custom Connect configuration being accessed.
enabledstringOptionalBoolean value that indicates whether the custom Connect configuration is enabled or not.
hasAccessstringOptional
senderSearchableItemsarrayOptional
senderSearchableItems[]stringEach item
Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.
Updates an existing brand — response body — colors item
FieldTypePresenceDescription and constraints
$objectRootA name-value pair that describes an item and provides a value for the item.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
namestringOptionalThe name of the item.
originalValuestringOptionalThe initial value of the item.
valuestringOptionalThe current value of the item.

Referenced models: Locks a template — response body — error Details

SDK function policy ID: docusign.esignature_permissionprofiles_getpermissionprofiles. Catalog operation: esignature:PermissionProfiles_GetPermissionProfiles. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.