UserExport: createUserListExport

Required scopes: user_read

This method initiates a user list export request. You specify the type of export request as JSON in the body of method, like this:

{
    "type": "organization_memberships_export"
}

The export request type is one of three values:

Value Description
organization_memberships_export Every user in every account in the organization. Users in multiple accounts will appear more than once.
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.

Request

HTTP request

POST /v2/organizations/{organizationId}/exports/user_list

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

Request Body

request

SDK Method

BulkOperations::createUserListExport

Definitions

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.OrganizationExportRequest

Lets you specify the kind of export request.

typestring

The type of export requested. One of:

  • organization_domain_users_export
  • organization_external_memberships_export
  • organization_memberships_export

DocuSign.Account.Common.Models.RestApi.Response.OrganizationExportResponse

Information about a single bulk export request. Note that both createUserListExport and getUserListExport return an object of this type as a response.

Some of the properties, such as completed do not apply to createUserListExport.

idstring

The unique ID of this request.

typestring

The type of export requested. One of:

  • organization_domain_users_export
  • organization_external_memberships_export
  • organization_memberships_export
  • organization_account_settings_export

Note that the last value is only for account settings export requests.

requestorDocuSign.Account.Common.Models.RestApi.Response.OrganizationExportRequestorResponse

The user who initiated the request.

createdstring

The time and date the request was created. This is a date in ISO 8601 format: 2019-03-26T19:02:09.8957715Z

last_modifiedstring

The time and date when the request was modified. This is typically the same as created.

completedstring

The time and date when the request completed. Null if the request is still in progress.

expiresstring

The time and date when the request expires.

statusstring

The status of the request. One of:

  • failed
  • in_process
  • queued
  • completed

metadata_urlstring

A pre-configured GET request to get the status of the export. Generally this is the same URI used to access this endpoint.

percent_completedinteger

An integer between 0 to 100 (inclusive) that reports the progress of the request.

number_rowsinteger

The number of rows returned in this request.

size_bytesinteger

The size of the requert in bytes.

results[DocuSign.Account.Common.Models.RestApi.Response.OrganizationExportTaskResponse]

An array of results. There is one set of results for each server an account is in.

successboolean

If true the request succeeded.

DocuSign.Account.Common.Models.RestApi.Response.OrganizationExportRequestorResponse

Describes who initiated the export request.

namestring

The name of the requestor.

idstring

The unique ID of the requestor. If type is user, this is the requestor's user ID.

typestring

The type of the requestor. One of:

  • user
  • client_app

emailstring

The email address of the requestor.

DocuSign.Account.Common.Models.RestApi.Response.OrganizationExportTaskResponse

The results of a user list or account settings export request.

idstring

The unique ID of the task request.

site_idinteger

The ID of the site the response is for..

urlstring

The URL that returns the results as a CSV text stream.

number_rowsinteger

The number of rows returned in the result.

size_bytesinteger

The size of the response in bytes.

error_detailsDocuSign.Account.Common.Models.RestApi.Response.OrganizationExportTaskResponse.ErrorDetails

Error results.

DocuSign.Account.Common.Models.RestApi.Response.OrganizationExportTaskResponse.ErrorDetails

Error details.

errorstring

The error ID.

error_descriptionstring

A description of the error.

}} />