Skip to content

DocuSign: Creates a user list export request

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

← Admin operations · Get started

Operation docusign.admin_organizationexport_organizationexport_insert

Provider route: POST /Management/v2/organizations/{organizationId}/exports/user_list. 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"]["adminOrganizationExportOrganizationExportInsert"]>[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.adminOrganizationExportOrganizationExportInsert(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_export_organization_export_insert(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 Creates a user list export request — request body — body

Referenced models: Creates a user list export request — 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 Creates a user list export request — response body

Referenced models: Creates a user list export request — response body

Creates a user list export request — response body
FieldTypePresenceDescription and constraints
$objectRoot
completedstringOptionalThe time and date when the request completed. Null if the request is still in progress.

Format: date-time
createdstringOptionalThe time and date the request was created. This is a date in ISO 8601 format.

Example: `2019-03-26T19:02:09.8957715Z`
Format: date-time
expiresstringOptionalThe time and date when the request expires.
Format: date-time
idstringOptionalThe unique ID of this request.
Format: uuid
last_modifiedstringOptionalThe time and date when the request was modified. This is typically the same as `created`.
Format: date-time
metadata_urlstringOptionalA pre-configured GET request to get the status of the export. Generally this is the same URI used to access this endpoint.
number_rowsJSONOptional
number_rows (anyOf 1)integerAlternativeThe number of rows returned in this request.

Format: int64
number_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
percent_completedJSONOptional
percent_completed (anyOf 1)integerAlternativeAn integer between 0 to 100 (inclusive) that reports the progress of the request.
Format: int32
percent_completed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestorModelOptionalExpand Closes external memberships — response body — requestor
The user who initiated the request.
resultsarrayOptionalAn array of results. There is one set of results for each server an account is in.
results[]ModelEach itemExpand Creates a user list export request — response body — results item
selected_accountsarrayOptional
selected_accounts[]ModelEach itemExpand Creates a user list export request — response body — selected accounts item
selected_domainsarrayOptional
selected_domains[]ModelEach itemExpand Creates a user list export request — response body — selected domains item
size_bytesJSONOptional
size_bytes (anyOf 1)integerAlternativeThe size of the request in bytes.
Format: int64
size_bytes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statusstringOptionalThe status of the request. One of:

- `failed`
- `in_process`
- `queued`
- `completed`
successbooleanOptionalWhen **true,** the request succeeded.
typestringOptionalThe type of export requested. One of:

- `organization_domain_users_export`: All users of the reserved domains.
- `organization_external_memberships_export`: Users whose email address domain is *not* linked to the organization.
- `organization_memberships_export`: Every user in every account in the organization. Users in multiple accounts will appear more than once.
- `organization_account_settings_export`: This value only applies to requests to export account settings.

Referenced models: Creates a user list export request — response body — selected accounts item, Creates a user list export request — response body — selected domains item, Closes external memberships — response body — requestor, Creates a user list export request — response body — results item

Creates a user list export request — request body — body
FieldTypePresenceDescription and constraints
$objectRootEnables you to specify the kind of export request.
accountsarrayOptional
accounts[]ModelEach itemExpand Creates a user list export request — response body — selected accounts item
domainsarrayOptional
domains[]ModelEach itemExpand Creates a user list export request — response body — selected domains item
typestringOptionalThe type of export requested. One of:

- `organization_domain_users_export`: All users of the reserved domains.
- `organization_external_memberships_export`: Users whose email address domain is *not* linked to the organization.
- `organization_memberships_export`: Every user in every account in the organization. Users in multiple accounts will appear more than once.
- `organization_account_settings_export`: This value only applies to requests to export account settings.

Referenced models: Creates a user list export request — response body — selected accounts item, Creates a user list export request — response body — selected domains item

Creates a user list export request — response body — selected accounts item
FieldTypePresenceDescription and constraints
$objectRoot
account_idstringOptionalSelect users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.
Format: uuid
Creates a user list export request — response body — selected domains item
FieldTypePresenceDescription and constraints
$objectRoot
domainstringOptional
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`
Creates a user list export request — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
error_detailsModelOptionalExpand Creates a user list export request — response body — results item error details
Error results.
idstringOptionalThe unique ID of the task request.
Format: uuid
number_rowsJSONOptional
number_rows (anyOf 1)integerAlternativeThe number of rows returned in the result.
Format: int64
number_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
site_idJSONOptional
site_id (anyOf 1)integerAlternativeThe ID of the site the response is for.
Format: int32
site_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
size_bytesJSONOptional
size_bytes (anyOf 1)integerAlternativeThe size of the response in bytes.
Format: int64
size_bytes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
urlstringOptionalThe URL that returns the results as a CSV text stream.

Referenced models: Creates a user list export request — response body — results item error details

Creates a user list export request — response body — results item error details
FieldTypePresenceDescription and constraints
$objectRoot
errorstringOptionalThe error number.
error_descriptionstringOptionalA longer description of the error.

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