Skip to content

DocuSign: Gets products associated with the account and the available permission profiles

DocuSign admin.adminOrganizationProductPermissionProfileGetProductPermissionProfiles: arguments, response, policy and SDK examples.

← Admin operations · Get started

Operation docusign.admin_organizationproductpermissionprofile_getproductpermissionprofiles

Provider route: GET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/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["admin"]["adminOrganizationProductPermissionProfileGetProductPermissionProfiles"]>[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.admin.adminOrganizationProductPermissionProfileGetProductPermissionProfiles(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.admin.admin_organization_product_permission_profile_get_product_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.organizationIdstringRequired within parentFormat: uuid
path.accountIdstringRequired within parentFormat: uuid

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieves a user’s product permission profiles by user ID — response body

Referenced models: Retrieves a user’s product permission profiles by user ID — response body

Retrieves a user's product permission profiles by user ID — response body
FieldTypePresenceDescription and constraints
$objectRoot
product_permission_profilesarrayOptionalA list of one or more products and their respective permissions.
Read only: true
product_permission_profiles[]ModelEach itemExpand Retrieves a user's product permission profiles by user ID — response body — product permission profiles item

Referenced models: Retrieves a user's product permission profiles by user ID — response body — product permission profiles item

Retrieves a user's product permission profiles by user ID — response body — product permission profiles item
FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringOptional
permission_profilesarrayOptional
permission_profiles[]ModelEach itemExpand Retrieves a user's product permission profiles by user ID — response body — product permission profiles item permission profiles item
product_idstringOptionalThe ID of the product.
Format: uuid
product_namestringOptionalThe human-readable name of the product.

Referenced models: Retrieves a user's product permission profiles by user ID — response body — product permission profiles item permission profiles item

Retrieves a user's product permission profiles by user ID — response body — product permission profiles item permission profiles item
FieldTypePresenceDescription and constraints
$objectRoot
permission_profile_idstringOptionalThe ID of the permission profile.
permission_profile_namestringOptionalThe human-readable name of the permission profile.

SDK function policy ID: docusign.admin_organizationproductpermissionprofile_getproductpermissionprofiles. Catalog operation: admin:OrganizationProductPermissionProfile_GetProductPermissionProfiles. 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.

Required provider scopes: ["user_read"]

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.