DocuSign: Returns the details of a single user import request
DocuSign admin.adminOrganizationImportOrganizationImportUsersGetById: arguments, response, policy and SDK examples.
← Admin operations · Get started
Operation docusign.admin_organizationimport_organizationimportusers_getbyid
Provider route: GET /Management/v2/organizations/{organizationId}/imports/bulk_users/{importId}. 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["admin"]["adminOrganizationImportOrganizationImportUsersGetById"]>[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.adminOrganizationImportOrganizationImportUsersGetById(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.admin.admin_organization_import_organization_import_users_get_by_id(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.organizationId | string | Required within parent | Format: uuid |
path.importId | string | Required within parent | Format: uuid |
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 Closes external memberships — response body |
Referenced models: Closes external memberships — response body
Schemas
Section titled “Schemas”Closes external memberships — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
added_user_count | JSON | Optional | |
added_user_count (anyOf 1) | integer | Alternative | Format: int32 |
added_user_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
closed_user_count | JSON | Optional | |
closed_user_count (anyOf 1) | integer | Alternative | Format: int32 |
closed_user_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created | string | Optional | Format: date-time |
error_count | JSON | Optional | |
error_count (anyOf 1) | integer | Alternative | Format: int32 |
error_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
file_level_error_rollups | array | Optional | |
file_level_error_rollups[] | Model | Each item | Expand Closes external memberships — response body — file level error rollups item |
has_csv_results | boolean | Optional | |
id | string | Optional | Format: uuid |
imports_failed_for_accounts | string | Optional | |
imports_failed_for_sites | string | Optional | |
imports_not_found_or_not_available_for_accounts | string | Optional | |
imports_not_found_or_not_available_for_sites | string | Optional | |
imports_timed_out_for_accounts | string | Optional | |
imports_timed_out_for_sites | string | Optional | |
invalid_column_headers | string | Optional | |
last_modified | string | Optional | Format: date-time |
no_action_required_user_count | JSON | Optional | |
no_action_required_user_count (anyOf 1) | integer | Alternative | Format: int32 |
no_action_required_user_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
processed_user_count | JSON | Optional | |
processed_user_count (anyOf 1) | integer | Alternative | Format: int32 |
processed_user_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestor | Model | Optional | Expand Closes external memberships — response body — requestor |
results_uri | string | Optional | |
status | string | Optional | Status. |
type | string | Optional | |
updated_user_count | JSON | Optional | |
updated_user_count (anyOf 1) | integer | Alternative | Format: int32 |
updated_user_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
user_count | JSON | Optional | |
user_count (anyOf 1) | integer | Alternative | Format: int32 |
user_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
user_level_error_rollups | array | Optional | |
user_level_error_rollups[] | Model | Each item | Expand Closes external memberships — response body — file level error rollups item |
user_level_warning_rollups | array | Optional | |
user_level_warning_rollups[] | Model | Each item | Expand Closes external memberships — response body — user level warning rollups item |
warning_count | JSON | Optional | |
warning_count (anyOf 1) | integer | Alternative | Format: int32 |
warning_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | The email address of the requestor. |
id | string | Optional | The unique ID of the requestor. If `type` is `user`, this is the requestor's user ID. |
name | string | Optional | The name of the requestor. |
type | string | Optional | The type of the requestor. One of: - `user` - `client_app` |
Closes external memberships — response body — file level error rollups item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
count | JSON | Optional | |
count (anyOf 1) | integer | Alternative | The number of errors of this type. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
error_type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
count | JSON | Optional | |
count (anyOf 1) | integer | Alternative | The number of warnings of this type. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
warning_type | string | Optional | The type of warning. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.admin_organizationimport_organizationimportusers_getbyid. Catalog operation: admin:OrganizationImport_OrganizationImportUsers_GetById. 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"]