Skip to content

DocuSign: Closes external memberships

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

← Admin operations · Get started

Operation docusign.admin_organizationimport_organizationimportusers_closeexternal

Provider route: POST /Management/v2/organizations/{organizationId}/imports/bulk_users/close_external. 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"]["adminOrganizationImportOrganizationImportUsersCloseExternal"]>[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.adminOrganizationImportOrganizationImportUsersCloseExternal(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_import_organization_import_users_close_external(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

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Closes external memberships — response body

Referenced models: Closes external memberships — response body

Closes external memberships — response body
FieldTypePresenceDescription and constraints
$objectRoot
added_user_countJSONOptional
added_user_count (anyOf 1)integerAlternativeFormat: int32
added_user_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
closed_user_countJSONOptional
closed_user_count (anyOf 1)integerAlternativeFormat: int32
closed_user_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdstringOptionalFormat: date-time
error_countJSONOptional
error_count (anyOf 1)integerAlternativeFormat: int32
error_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
file_level_error_rollupsarrayOptional
file_level_error_rollups[]ModelEach itemExpand Closes external memberships — response body — file level error rollups item
has_csv_resultsbooleanOptional
idstringOptionalFormat: uuid
imports_failed_for_accountsstringOptional
imports_failed_for_sitesstringOptional
imports_not_found_or_not_available_for_accountsstringOptional
imports_not_found_or_not_available_for_sitesstringOptional
imports_timed_out_for_accountsstringOptional
imports_timed_out_for_sitesstringOptional
invalid_column_headersstringOptional
last_modifiedstringOptionalFormat: date-time
no_action_required_user_countJSONOptional
no_action_required_user_count (anyOf 1)integerAlternativeFormat: int32
no_action_required_user_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
processed_user_countJSONOptional
processed_user_count (anyOf 1)integerAlternativeFormat: int32
processed_user_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestorModelOptionalExpand Closes external memberships — response body — requestor
results_uristringOptional
statusstringOptionalStatus.
typestringOptional
updated_user_countJSONOptional
updated_user_count (anyOf 1)integerAlternativeFormat: int32
updated_user_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
user_countJSONOptional
user_count (anyOf 1)integerAlternativeFormat: int32
user_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
user_level_error_rollupsarrayOptional
user_level_error_rollups[]ModelEach itemExpand Closes external memberships — response body — file level error rollups item
user_level_warning_rollupsarrayOptional
user_level_warning_rollups[]ModelEach itemExpand Closes external memberships — response body — user level warning rollups item
warning_countJSONOptional
warning_count (anyOf 1)integerAlternativeFormat: int32
warning_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Closes external memberships — response body — requestor, Closes external memberships — response body — file level error rollups item, Closes external memberships — response body — user level warning rollups item

Closes external memberships — response body — requestor
FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalThe email address of the requestor.
idstringOptionalThe unique ID of the requestor.
If `type` is `user`, this is the requestor's user ID.
namestringOptionalThe name of the requestor.
typestringOptionalThe type of the requestor. One of:

- `user`
- `client_app`
Closes external memberships — response body — file level error rollups item
FieldTypePresenceDescription and constraints
$objectRoot
countJSONOptional
count (anyOf 1)integerAlternativeThe number of errors of this type.
Format: int32
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
error_typestringOptionalThe type of error. One of:


- `no_action_taken_user_exists`
- `user_added`
- `user_updated`
- `invalid_column_header`
- `invalid_row_data`
- `insufficient_row_data_found`
- `extra_row_data_found`
- `blank_username`
- `invalid_characters_in_username`
- `invalid_useremail_address`
- `email_domain_is_reserved`
- `new_name_with_existing_useremail_not_allowed`
- `invalid_characters_in_jobtitle`
- `invalid_membership_id`
- `membership_not_in_account`
- `maximum_users_exceeded`
- `invalid_permissionset`
- `user_permissionset_problems`
- `invalid_group`
- `user_group_problems`
- `group_and_permissionset_problems`
- `column_headers_missing`
- `invalid_csv_data_or_syntax`
- `invalid_characters_in_companyname`
- `invalid_language_code`
- `username_column_header_missing`
- `useremail_column_header_missing`
- `permissionset_column_header_missing`
- `membership_id_column_header_usage_not_permitted`
- `administrator_group_assignment_not_permitted`
- `user_awaiting_activation`
- `account_admin_access_denied`
- `invalid_characters_in_address`
- `permissionset_required`
- `apiusername_column_header_missing`
- `invalid_apiusername`
- `useremail_username_combination_exists`
- `permissionset_change_not_allowed`
- `username_language_changes_ignored_warning`
- `invalid_country_warning`
- `invalid_account_id`
- `invalid_autoactivate`
- `invalid_loginpolicy`
- `autoactivate_not_allowed`
- `membership_closed`
- `membership_closed_or_disabled_warning`
- `cannot_close_last_active_admin`
- `no_action_taken`
- `cannot_close_own_membership`
- `unspecified_error`

Closes external memberships — response body — user level warning rollups item
FieldTypePresenceDescription and constraints
$objectRoot
countJSONOptional
count (anyOf 1)integerAlternativeThe number of warnings of this type.
Format: int32
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
warning_typestringOptionalThe type of warning.

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