Skip to content

DocuSign: Revokes a user's access to one or more products

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

← Admin operations · Get started

Operation docusign.admin_organizationproductpermissionprofile_removeuserproducts

Provider route: DELETE /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users. 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"]["adminOrganizationProductPermissionProfileRemoveUserProducts"]>[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.adminOrganizationProductPermissionProfileRemoveUserProducts(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_remove_user_products(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
bodyModelRequired within parentExpand Revokes a user’s access to one or more products — request body — body

Referenced models: Revokes a user’s access to one or more products — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Revokes a user’s access to one or more products — response body

Referenced models: Revokes a user’s access to one or more products — response body

Revokes a user's access to one or more products — response body
FieldTypePresenceDescription and constraints
$objectRoot
is_successbooleanRequired within parentWhen **true,** indicates that the user's access to the specified products was successfully revoked.
user_emailstringOptionalThe user's email address.
user_idstringOptionalThe user's ID.
Format: uuid
user_product_resultsobjectRequired within parentThe results of the request to revoke product access.

Each key in the object is the ID of a product specified in the request. Each corresponding value indicates whether the user's access for that product was successfully revoked. If successful, the value is `deleted`. Otherwise, the value describes the error that occurred.

For example:
```
{
"230546a7-xxxx-xxxx-xxxx-af205d5494ad"": "deleted",
"984800b7-xxxx-xxxx-xxxx-kt374a5922lk": "Invalid product id"
}
```
Additional keys: see wildcard field
user_product_results.*stringAdditional keys
Revokes a user's access to one or more products — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
product_idsarrayRequired within parentA list of IDs corresponding to the products for which the user's access will be revoked.

For example:

`["230546a7-xxxx-xxxx-xxxx-af205d5494ad", "984800b7-xxxx-xxxx-xxxx-kt374a5922lk"]`
product_ids[]stringEach itemFormat: uuid
user_emailstringOptionalThe user's email address.
user_idstringOptionalThe user's unique ID.
Format: uuid

SDK function policy ID: docusign.admin_organizationproductpermissionprofile_removeuserproducts. Catalog operation: admin:OrganizationProductPermissionProfile_RemoveUserProducts. 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_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.