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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.include | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Gets a list of permission profiles — response body |
Referenced models: Gets a list of permission profiles — response body
Schemas
Section titled “Schemas”11 more schemas are linked from the tables above, on the schema pages.
Gets a list of permission profiles — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details about the permission profiles associated with an account. |
permissionProfiles | array | Optional | A complex type containing a collection of permission profiles. |
permissionProfiles[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object defines the account permissions for a profile that you can apply to a group of users. |
modifiedByUsername | string | Optional | The username of the user who last modified the permission profile. |
modifiedDateTime | string | Optional | The date and time when the permission profile was last modified. |
permissionProfileId | string | Optional | The 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. |
permissionProfileName | string | Optional | The name of the account permission profile. Example: `Account Administrator` |
settings | Model | Optional | Expand Returns a permission profile for an account — response body — settings This object specifies the permissions that are associated with the account permission profile. |
userCount | string | Optional | The total number of users in the group associated with the account permission profile. |
users | array | Optional | A list of user objects containing information about the users who are associated with the account permission profile. |
users[] | Model | Each item | Expand 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata that indicates whether a property is editable and describes setting-specific options. |
is21CFRPart11 | string | Optional | When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). |
options | array | Optional | An array of option strings supported by this setting. |
options[] | string | Each item | |
rights | string | Optional | Indicates whether the property is editable. Valid values are: - `editable` - `read_only` |
uiHint | string | Optional | Reserved for Docusign. |
uiOrder | string | Optional | Reserved for Docusign. |
uiType | string | Optional | Reserved for Docusign. |
Get credit card information — response body — address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains address information. |
address1 | string | Optional | The first line of the user's address. Maximum length: 100 characters. |
address2 | string | Optional | The second line of the user's address. Maximum length: 100 characters. |
city | string | Optional | The user's city. Maximum length: 40 characters. |
country | string | Optional | The user's country. Maximum length: 50 characters. |
fax | string | Optional | A fax number associated with the address, if one is available. |
phone | string | Optional | A phone number associated with the address. |
postalCode | string | Optional | The user's postal code. Maximum length: 20 characters. |
stateOrProvince | string | Optional | The user's state or province. Maximum length: 40 characters. |
zipPlus4 | string | Optional |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
configurationtype | string | Optional | The type of custom Connect configuration being accessed. |
connectId | string | Optional | The ID of the custom Connect configuration being accessed. |
enabled | string | Optional | Boolean value that indicates whether the custom Connect configuration is enabled or not. |
hasAccess | string | Optional | |
senderSearchableItems | array | Optional | |
senderSearchableItems[] | string | Each item |
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Updates an existing brand — response body — colors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A name-value pair that describes an item and provides a value for the item. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
name | string | Optional | The name of the item. |
originalValue | string | Optional | The initial value of the item. |
value | string | Optional | The current value of the item. |
Referenced models: Locks a template — response body — error Details
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.