Skip to content

DocuSign: Deletes data for one or more of a user's account memberships

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

← Admin operations · Get started

Operation docusign.admin_dataredaction_redactindividualuserdata

Provider route: POST /Management/v2/data_redaction/organizations/{organizationId}/user. 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"]["adminDataRedactionRedactIndividualUserData"]>[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.adminDataRedactionRedactIndividualUserData(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_data_redaction_redact_individual_user_data(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
bodyModelRequired within parentExpand Deletes data for one or more of a user’s account memberships — request body — body

Referenced models: Deletes data for one or more of a user’s account memberships — 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 Deletes membership data for a user on an account — response body

Referenced models: Deletes membership data for a user on an account — response body

Deletes membership data for a user on an account — response body
FieldTypePresenceDescription and constraints
$objectRoot
membership_resultsarrayOptionalA list of objects describing the status of the deletion request for each account.
Read only: true
membership_results[]ModelEach itemExpand Deletes membership data for a user on an account — response body — membership results item
statusstringOptionalThe overall status of the data deletion request.
Known values: unknown, pending, failure, success, already_redacted
Read only: true
user_idstringOptionalThe ID of the user.
Format: uuid
Read only: true

Referenced models: Deletes membership data for a user on an account — response body — membership results item

Deletes data for one or more of a user's account memberships — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
membershipsarrayOptionalA list of accounts from which you want to delete the user's data. At least one account is required.
memberships[]ModelEach itemExpand Deletes data for one or more of a user's account memberships — request body — body memberships item
user_idstringOptionalThe ID of the user whose data you want to delete.
Format: uuid

Referenced models: Deletes data for one or more of a user's account memberships — request body — body memberships item

Deletes membership data for a user on an account — response body — membership results item
FieldTypePresenceDescription and constraints
$objectRootAn object describing the status of the data deletion request for a specific account.
account_idstringOptionalThe ID of the account.
Format: uuid
Read only: true
statusstringOptionalThe status of the data deletion request. Valid values:
- `success`
- `pending`
- `failure`
- `already_redacted`

Known values: unknown, pending, failure, success, already_redacted
Read only: true
Deletes data for one or more of a user's account memberships — request body — body memberships item
FieldTypePresenceDescription and constraints
$objectRoot
account_idstringOptionalThe ID of the account from which to delete the user's data.
Format: uuid

SDK function policy ID: docusign.admin_dataredaction_redactindividualuserdata. Catalog operation: admin:DataRedaction_RedactIndividualUserData. 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_data_redact"]

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.