Skip to content

DocuSign: Admin schemas

101 DocuSign schemas with complete fields and constraints.

← Admin operations · All schemas

Activates user memberships — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
site_idintegerRequired within parentFormat: int32

Activates user memberships — response body

FieldTypePresenceDescription and constraints
$objectRootA response.
statusstringOptionalThe status of the request.

Adds a list of users to a DS Group — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
user_idsarrayRequired within parent
user_ids[]stringEach itemFormat: uuid

Adds a list of users to a DS Group — response body

FieldTypePresenceDescription and constraints
$objectRoot
groupModelOptionalExpand Creates a new DS Group — response body
group_usersModelOptionalExpand Adds a list of users to a DS Group — response body — group users

Referenced models: Adds a list of users to a DS Group — response body — group users, Creates a new DS Group — response body

Adds a list of users to a DS Group — response body — group users

FieldTypePresenceDescription and constraints
$objectRoot
TotalCountJSONOptional
TotalCount (anyOf 1)integerAlternativeFormat: int32
TotalCount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
is_successbooleanOptional
usersarrayOptionalA list of users.
users[]ModelEach itemExpand Removes a list of users from a DS Group — response body — failed users item

Referenced models: Removes a list of users from a DS Group — response body — failed users item

Closes a user's memberships — request body — body

FieldTypePresenceDescription and constraints
$objectRootA list of accounts to close for a user.
accountsarrayRequired within parentA list of accounts to close for a user.
accounts[]ModelEach itemExpand Closes a user's memberships — request body — body accounts item

Referenced models: Closes a user's memberships — request body — body accounts item

Closes a user's memberships — request body — body accounts item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe ID of a user's account you want to close.
Format: uuid

Closes a user's memberships — response body

FieldTypePresenceDescription and constraints
$objectRootThe results of closing a user's account.
accountsarrayOptionalA list of accounts that were closed.
accounts[]ModelEach itemExpand Closes a user's memberships — response body — accounts item
successbooleanOptionalWhen **true,** the request to close the accounts succeeded.

Referenced models: Closes a user's memberships — response body — accounts item

Closes a user's memberships — response body — accounts item

FieldTypePresenceDescription and constraints
$objectRootResults of closing accounts.
error_detailsModelOptionalExpand Updates a user's email address — response body — users item error details
Error results.
idstringOptionalThe ID of an account that could not be closed.
Format: uuid

Referenced models: Updates a user's email address — response body — users item error details

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 — 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 — 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 — 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.

Creates a new DS Group — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptional
group_namestringRequired within parent

Creates a new DS Group — response body

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
account_namestringOptional
descriptionstringOptional
ds_group_idstringOptionalFormat: uuid
external_account_idJSONOptional
external_account_id (anyOf 1)integerAlternativeFormat: int64
external_account_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
group_idstringOptional
group_namestringOptional
is_adminbooleanOptional
is_managed_by_scimbooleanOptional
last_modified_onstringOptionalFormat: date-time
source_product_namestringOptional
user_countJSONOptional
user_count (anyOf 1)integerAlternativeFormat: int32
user_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Creates a new account settings export request — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accountsarrayOptional
accounts[]ModelEach itemExpand Creates a new account settings export request — request body — body accounts item

Referenced models: Creates a new account settings export request — request body — body accounts item

Creates a new account settings export request — request body — body accounts item

FieldTypePresenceDescription and constraints
$objectRoot
account_idstringRequired within parentSelect 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 new account settings import request — response body

FieldTypePresenceDescription and constraints
$objectRoot
completedstringOptionalFormat: date-time
createdstringOptionalFormat: date-time
expiresstringOptionalFormat: date-time
idstringOptional
last_modifiedstringOptionalFormat: date-time
number_processed_accountsJSONOptional
number_processed_accounts (anyOf 1)integerAlternativeFormat: int64
number_processed_accounts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_unprocessed_accountsJSONOptional
number_unprocessed_accounts (anyOf 1)integerAlternativeFormat: int64
number_unprocessed_accounts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
organization_idstringOptional
percent_completedJSONOptional
percent_completed (anyOf 1)integerAlternativeFormat: int32
percent_completed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestorModelOptionalExpand Creates a new account settings import request — response body — requestor
resultsarrayOptional
results[]ModelEach itemExpand Creates a new account settings import request — response body — results item
skipped_settings_by_accountobjectOptionalAdditional keys: see wildcard field
skipped_settings_by_account.*arrayAdditional keys
skipped_settings_by_account.*[]stringEach item
statusstringOptionalStatus.
successbooleanOptional
typestringOptional

Referenced models: Creates a new account settings import request — response body — requestor, Creates a new account settings import request — response body — results item

Creates a new account settings import request — response body — requestor

FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalThe email address.
idstringOptional
namestringOptional
typestringOptional

Creates a new account settings import 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.
idstringOptionalFormat: uuid
number_processed_accountsJSONOptional
number_processed_accounts (anyOf 1)integerAlternativeFormat: int64
number_processed_accounts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_unprocessed_accountsJSONOptional
number_unprocessed_accounts (anyOf 1)integerAlternativeFormat: int64
number_unprocessed_accounts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
processing_issues_by_accountarrayOptional
processing_issues_by_account[]ModelEach itemExpand Creates a new account settings import request — response body — results item processing issues by account item
site_idJSONOptional
site_id (anyOf 1)integerAlternativeFormat: int32
site_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
urlstringOptional

Referenced models: Creates a user list export request — response body — results item error details, Creates a new account settings import request — response body — results item processing issues by account item

Creates a new account settings import request — response body — results item processing issues by account 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.
account_namestringOptional
errorstringOptionalThe error number.
error_keystringOptional
setting_keystringOptional

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

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 — 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.

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

Delete user identities for a specified identity provider — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest to delete a user's identities,
identitiesarrayRequired within parentA list of identities.
identities[]ModelEach itemExpand Delete user identities for a specified identity provider — request body — body identities item

Referenced models: Delete user identities for a specified identity provider — request body — body identities item

Delete user identities for a specified identity provider — request body — body identities item

FieldTypePresenceDescription and constraints
$objectRootUser identity,
idstringOptionalThe `provider_id` that is returned from calling `getUserProfiles`.
Format: uuid

Delete user identities for a specified identity provider — response body

FieldTypePresenceDescription and constraints
$objectRootResults of deleting identities.
identitiesarrayOptionalA list of identities to delete.
identities[]ModelEach itemExpand Delete user identities for a specified identity provider — response body — identities item
successbooleanOptionalWhen **true,** the request succeeded.

Referenced models: Delete user identities for a specified identity provider — response body — identities item

Delete user identities for a specified identity provider — response body — identities item

FieldTypePresenceDescription and constraints
$objectRootResults of deleting a user identity.
error_detailsModelOptionalExpand Updates a user's email address — response body — users item error details
Error results.
idstringOptionalThe ID of the result.
Format: uuid
immutable_idstringOptionalA unique ID to identify the removed user.
provider_idstringOptionalThe ID of the identity provider.
Format: uuid
user_idstringOptionalThe user ID.
Format: uuid

Referenced models: Updates a user's email address — response body — users item error details

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 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

Deletes membership data for a user on an account — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
user_idstringOptionalThe ID of the user whose data you want to delete.
Format: uuid

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 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

Get a single account creation process — response body

FieldTypePresenceDescription and constraints
$objectRoot
assetGroupIdstringOptionalThe ID of the asset group to which the accounts belong.
Format: uuid
Read only: true
assetGroupWorkIdstringOptionalThe ID of the job that is created by the request.
Format: uuid
Read only: true
assetGroupWorkTypestringOptionalThe type of asset group work. This property is read-only.
Known values: Undefined, GroupAssetFulfillment, AccountAssetFulfillment, AccountAssetClone, AccountAssetCreate, SubscriptionSync
Read only: true
attemptsJSONOptional
attempts (anyOf 1)integerAlternativeThe number of times the job has been attempted.
Format: int32
Read only: true
attempts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createAccountProcessingFailureDetailsModelOptionalExpand Gets information about a single cloned account — response body — clone Processing Failure Details
The processing failure details if the job has a status of `PendingError` or `ProcessingError`.
Read only: true
createdByEmailstringOptionalThe email of the creator of the account clone work.
Read only: true
createdByNamestringOptionalThe name of the creator of the account clone work.
Read only: true
createdDatestringOptionalThe date the account clone work is created.
Format: date-time
Read only: true
messagestringOptionalThe message associated with the account clone work.
Read only: true
orderIdstringOptionalThe order ID created by the clone work.

Format: uuid
Read only: true
statusstringOptionalThe status of the account creation request.
Known values: Undefined, Pending, Processing, ProcessingOnHold, PendingError, ProcessingError, Completed, Canceled, PermanentFailure
Read only: true
subscriptionDetailsModelRequired within parentExpand Get a single account creation process — response body — subscription Details
The subscription info for the new account.
targetAccountModelRequired within parentExpand Get a single account creation process — response body — target Account
The target account to clone to.

Referenced models: Get a single account creation process — response body — subscription Details, Get a single account creation process — response body — target Account, Gets information about a single cloned account — response body — clone Processing Failure Details

Get a single account creation process — response body — subscription Details

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalSubscription ID
modulesarrayOptionalList of module IDs selected for creating the new account
modules[]ModelEach itemExpand Get a single account creation process — response body — subscription Details modules item
planIdstringOptionalPlan ID
Format: uuid
planNamestringOptionalPlan name

Referenced models: Get a single account creation process — response body — subscription Details modules item

Get a single account creation process — response body — subscription Details modules item

FieldTypePresenceDescription and constraints
$objectRoot
moduleIdstringOptionalModule ID
Format: uuid
moduleNamestringOptionalModule name

Get a single account creation process — response body — target Account

FieldTypePresenceDescription and constraints
$objectRoot
adminModelOptionalExpand Get a single account creation process — response body — target Account admin
The admin user for the target account.
countryCodestringOptionalThe country code where the target account is in. This value is ignored if region is provided.
idstringOptionalThe account ID of the new account. The GUID will be empty if the account has not been created yet.
Format: uuid
namestringOptionalThe name of the target account.
regionstringOptionalThe region where the target account is in.
sitestringOptionalThe site where the target account is on.

Referenced models: Get a single account creation process — response body — target Account admin

Get a single account creation process — response body — target Account admin

FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalThe email address of the target account's admin user.
firstNamestringOptional
lastNamestringOptional
localestringOptionalKnown values: None, zh_cn, zh_tw, nl, en, fr, de, it, ja, ko, pt, pt_br, ru, es, pl

Get all ongoing account creation processes for an Organization — response body

FieldTypePresenceDescription and constraints
$objectRoot
assetGroupWorksarrayOptionalThe list of asset group accounts.
Read only: true
assetGroupWorks[]ModelEach itemExpand Get a single account creation process — response body

Referenced models: Get a single account creation process — response body

Get asset group accounts for an organization — response body

FieldTypePresenceDescription and constraints
$objectRootA list of asset group accounts.
assetGroupAccountsarrayOptionalThe list of asset group accounts.
Read only: true
assetGroupAccounts[]ModelEach itemExpand Get asset group accounts for an organization — response body — asset Group Accounts item

Referenced models: Get asset group accounts for an organization — response body — asset Group Accounts item

Get asset group accounts for an organization — response body — asset Group Accounts item

FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringOptionalThe ID of the account.
Format: uuid
Read only: true
accountNamestringOptionalThe name of the account.
Read only: true
assetGroupIdstringOptionalThe asset group ID.
Format: uuid
Read only: true
assetGroupNamestringOptionalReserved for Docusign.
Read only: true
compliantbooleanOptionalWhen **true,** indicates that the account is compliant.
Read only: true
externalAccountIdJSONOptional
externalAccountId (anyOf 1)integerAlternativeThe external account ID.

Format: int64
Read only: true
externalAccountId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
siteIdJSONOptional
siteId (anyOf 1)integerAlternativeReserved for Docusign.
Format: int32
Read only: true
siteId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
siteNamestringOptionalReserved for Docusign.
Read only: true

Get information about plan items within an organization — response body — item

FieldTypePresenceDescription and constraints
$objectRoot
asset_group_idstringOptionalFormat: uuid
asset_group_namestringOptional
associated_accounts_countJSONOptional
associated_accounts_count (anyOf 1)integerAlternativeFormat: int32
associated_accounts_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
modulesarrayOptionalList of module IDs selected for creating the new account
modules[]ModelEach itemExpand Get information about plan items within an organization — response body — item modules item
plan_idstringOptionalFormat: uuid
plan_namestringOptional
subscription_idstringOptional
subscription_namestringOptional

Referenced models: Get information about plan items within an organization — response body — item modules item

Get information about plan items within an organization — response body — item modules item

FieldTypePresenceDescription and constraints
$objectRoot
plan_item_descriptionstringOptional
plan_item_idstringOptionalFormat: uuid
plan_item_internal_idstringOptional
plan_item_namestringOptional

Gets a list of all of the user import requests — response body

FieldTypePresenceDescription and constraints
$objectRoot
importsarrayOptionalA list of responses to user import requests.
imports[]ModelEach itemExpand Closes external memberships — response body

Referenced models: Closes external memberships — response body

Gets a list of users in a DS Group — response body

FieldTypePresenceDescription and constraints
$objectRoot
groupModelOptionalExpand Creates a new DS Group — response body
group_usersModelOptionalExpand Gets a list of users in a DS Group — response body — group users

Referenced models: Creates a new DS Group — response body, Gets a list of users in a DS Group — response body — group users

Gets a list of users in a DS Group — response body — group users

FieldTypePresenceDescription and constraints
$objectRoot
pageJSONOptional
page (anyOf 1)integerAlternativeThe page number.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page_sizeJSONOptional
page_size (anyOf 1)integerAlternativeThe number of items per page.
Format: int32
page_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_countJSONOptional
total_count (anyOf 1)integerAlternativeFormat: int32
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
usersarrayOptionalA list of users.
users[]ModelEach itemExpand Removes a list of users from a DS Group — response body — failed users item

Referenced models: Removes a list of users from a DS Group — response body — failed users item

Gets all asset group account clones for an organization — response body

FieldTypePresenceDescription and constraints
$objectRoot
assetGroupWorksarrayOptionalThe list of asset group accounts.
Read only: true
assetGroupWorks[]ModelEach itemExpand Gets information about a single cloned account — response body

Referenced models: Gets information about a single cloned account — response body

Gets information about a single cloned account — response body

FieldTypePresenceDescription and constraints
$objectRootThe account that is cloned.
assetGroupIdstringOptionalThe ID of the asset group to which the account belongs. Use this value to retrieve information about the clone request with the [getAssetGroupAccountClone](/docs/admin-api/reference/accountprovisioning/accountcloning/getassetgroupaccountclone/) endpoint.

This property is read-only.
Format: uuid
Read only: true
assetGroupWorkIdstringOptionalThe ID of the job that is created by the request. Use this value to retrieve information about the clone request with the [getAssetGroupAccountClone](/docs/admin-api/reference/accountprovisioning/accountcloning/getassetgroupaccountclone/) endpoint.

This property is read-only.
Format: uuid
Read only: true
assetGroupWorkTypestringOptionalThe type of asset group work. This property is read-only.
Known values: Undefined, GroupAssetFulfillment, AccountAssetFulfillment, AccountAssetClone, AccountAssetCreate, SubscriptionSync
Read only: true
attemptsJSONOptional
attempts (anyOf 1)integerAlternativeThe number of retries. This property is read-only.
Format: int32
Read only: true
attempts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cloneProcessingFailureDetailsModelOptionalExpand Gets information about a single cloned account — response body — clone Processing Failure Details
The processing failures if the work is in `PendingError` or `ProcessingError` status. This property is read-only.
Read only: true
cloneRequestIdstringOptionalReserved for Docusign.
Format: uuid
Read only: true
createdByEmailstringOptionalThe email address of the user who initiated the clone request. This property is read-only.
Read only: true
createdByNamestringOptionalThe name of the user who initiated the clone request. This property is read-only.
Read only: true
createdDatestringOptionalThe date that the clone request was initiated. This property is read-only.
Format: date-time
Read only: true
messagestringOptionalA message providing information about the clone request. If the request resulted in an error, this message includes specific information about the error.

This property is read-only.
Read only: true
orderIdstringOptionalReserved for Docusign.
Format: uuid
Read only: true
sourceAccountModelRequired within parentExpand Gets information about a single cloned account — response body — source Account
The source account that is cloned.
statusstringOptionalThe status of the clone request. Valid values:
* `Pending`
* `Processing`
* `PendingError`
* `ProcessingError`
* `Completed`
* `Canceled`
* `PermanentFailure`

This property is read-only.
Known values: Undefined, Pending, Processing, ProcessingOnHold, PendingError, ProcessingError, Completed, Canceled, PermanentFailure
Read only: true
targetAccountModelRequired within parentExpand Gets information about a single cloned account — response body — target Account
The target account that is created.

Referenced models: Gets information about a single cloned account — response body — source Account, Gets information about a single cloned account — response body — target Account, Gets information about a single cloned account — response body — clone Processing Failure Details

Gets information about a single cloned account — response body — clone Processing Failure Details

FieldTypePresenceDescription and constraints
$objectRoot
errorstringOptionalThe error code.
Read only: true
errorDescriptionstringOptionalThe error description.
Read only: true
isSystemErrorbooleanOptionalWhether the error is caused by the system or user.
Read only: true

Gets information about a single cloned account — response body — source Account

FieldTypePresenceDescription and constraints
$objectRoot
externalAccountIdJSONOptional
externalAccountId (anyOf 1)integerAlternativeThe external account ID of the source account.

Format: int64
Read only: true
externalAccountId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentThe ID of the account to clone. This property is required in POST requests.

Format: uuid
namestringOptionalThe name of the source account.
Read only: true
sitestringOptionalThe site the source account is on.
Read only: true

Gets information about a single cloned account — response body — target Account

FieldTypePresenceDescription and constraints
$objectRootAn object describing the target cloned account.
adminModelOptionalExpand Gets information about a single cloned account — response body — target Account admin
The administrator of the new account. This property is required in the request body when cloning an account.
countryCodestringOptionalThe two-letter [ISO 3166](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code of the target account.

**Note:** When cloning an account, you must include this property or `region`. If both are provided, `region` will be used.
idstringOptionalThe ID of the target account. This property is read-only.
Format: uuid
namestringOptionalThe name of the target account. This property is required in the request body when cloning an account.
regionstringOptionalThe region of the target account. When testing in the developer environment, the region will always be `NA`.

**Note:** When cloning an account, you must include this property or `countryCode` in the request. If both are provided, `region` will be used.
sitestringOptionalThe data center site of the account. This property is read-only.

Referenced models: Gets information about a single cloned account — response body — target Account admin

Gets information about a single cloned account — response body — target Account admin

FieldTypePresenceDescription and constraints
$objectRootAn object describing the administrator of the cloned account.
emailstringOptionalThe email address of the target account administrator. This property is required in the request body when cloning an account.
firstNamestringOptionalThe first name of the target account administrator. This property is required in the request body when cloning an account.
lastNamestringOptionalThe last name of the target account administrator. This property is required in the request body when cloning an account.
localestringOptionalThe locale of the target account administrator. The locale code for the United States is `en`.
Known values: None, zh_cn, zh_tw, nl, en, fr, de, it, ja, ko, pt, pt_br, ru, es, pl

Removes a list of users from a DS Group — request body — body

FieldTypePresenceDescription and constraints
$objectRootInformation about users to remove from the group.
user_emailsarrayOptionalAn array of emails associated with users to remove from the group. **Note:** If `user_ids` is also specified, this parameter will be ignored.
user_emails[]stringEach item
user_idsarrayOptionalAn array of IDs corresponding to users to remove from the group.
user_ids[]stringEach itemFormat: uuid

Removes a list of users from a DS Group — response body

FieldTypePresenceDescription and constraints
$objectRoot
failed_usersarrayOptional
failed_users[]ModelEach itemExpand Removes a list of users from a DS Group — response body — failed users item
is_successbooleanOptional

Referenced models: Removes a list of users from a DS Group — response body — failed users item

Removes a list of users from a DS Group — response body — failed users 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
error_detailsModelOptionalExpand Updates a user's email address — response body — users item error details
Error results.
first_namestringOptionalThe user's first name.
last_namestringOptionalThe user's last name.
middle_namestringOptional
statusstringOptionalStatus.
user_idstringOptionalFormat: uuid
user_namestringOptionalThe full name of the user.

Referenced models: Updates a user's email address — response body — users item error details

Retrieves a user's product permission profiles by email address — response body

FieldTypePresenceDescription and constraints
$objectRoot
account_idstringOptionalThe ID of the account.
Format: uuid
product_permission_profilesarrayOptionalA list of one or more products and their respective permissions.
product_permission_profiles[]ModelEach itemExpand Retrieves a user's product permission profiles by user ID — response body — product permission profiles item
user_idstringOptionalThe ID of the user.
Format: uuid

Referenced models: Retrieves a user's product permission profiles by user ID — response body — product permission profiles item

Retrieves a user's product permission profiles by user ID — response body

FieldTypePresenceDescription and constraints
$objectRoot
product_permission_profilesarrayOptionalA list of one or more products and their respective permissions.
Read only: true
product_permission_profiles[]ModelEach itemExpand Retrieves a user's product permission profiles by user ID — response body — product permission profiles item

Referenced models: Retrieves a user's product permission profiles by user ID — response body — product permission profiles item

Retrieves a user's product permission profiles by user ID — response body — product permission profiles item

FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringOptional
permission_profilesarrayOptional
permission_profiles[]ModelEach itemExpand Retrieves a user's product permission profiles by user ID — response body — product permission profiles item permission profiles item
product_idstringOptionalThe ID of the product.
Format: uuid
product_namestringOptionalThe human-readable name of the product.

Referenced models: Retrieves a user's product permission profiles by user ID — response body — product permission profiles item permission profiles item

Retrieves a user's product permission profiles by user ID — response body — product permission profiles item permission profiles item

FieldTypePresenceDescription and constraints
$objectRoot
permission_profile_idstringOptionalThe ID of the permission profile.
permission_profile_namestringOptionalThe human-readable name of the permission profile.

Retrieves the DS profile for a user specified by ID — response body

FieldTypePresenceDescription and constraints
$objectRootInformation about a list of users.
usersarrayOptionalA list of users.
users[]ModelEach itemExpand Retrieves the DS profile for a user specified by ID — response body — users item

Referenced models: Retrieves the DS profile for a user specified by ID — response body — users item

Retrieves the DS profile for a user specified by ID — response body — users item

FieldTypePresenceDescription and constraints
$objectRootInformation about a user.
allow_extend_org_admin_rights_to_selfbooleanOptional
allow_two_step_verification_snoozebooleanOptional
created_onstringOptionalThe date the user's account was created.
Format: date-time
default_account_idstringOptionalThe ID of the user's default account.
Format: uuid
default_account_namestringOptionalThe name of the user's default account.
device_verification_enabledbooleanOptional
federated_statusstringOptionalThe user's federated status. One of:

- `RemoveStatus`
- `FedAuthRequired`
- `FedAuthBypass`
- `Evicted`
first_namestringOptionalThe user's first name.
idstringOptionalThe user's unique ID.
Format: uuid
identitiesarrayOptionalA list of identities associated with the user.
identities[]ModelEach itemExpand Delete user identities for a specified identity provider — response body — identities item
is_managed_by_scimbooleanOptional
is_organization_adminbooleanOptionalWhen **true,** the user has organization administration privileges.
language_culturestringOptionalThe language and culture of the user.

* Chinese Simplified: `zh_CN`
* Chinese Traditional: `zh_TW`
* Dutch: `nl`
* English: `en`
* French: `fr`
* German: `de`
* Italian: `it`
* Japanese: `ja`
* Korean: `ko`
* Portuguese: `pt`
* Portuguese Brazil: `pt_BR`
* Russian: `ru`
* Spanish: `es`
last_loginstringOptionalThis property has been deprecated.
Format: date-time
last_namestringOptionalThe user's last name.
membershipsarrayOptionalA list of organizations that have groups that the user is a member of.
memberships[]ModelEach itemExpand Retrieves the DS profile for a user specified by ID — response body — users item memberships item
require_two_step_verificationbooleanOptional
selected_languagesstringOptional
site_idJSONOptional
site_id (anyOf 1)integerAlternativeThe site ID of the organization.
Format: int32
site_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
site_namestringOptionalThe site name of the account.
user_namestringOptionalThe full name of the user.
user_statusstringOptionalThe user's status. One of:

- `active`
- `created`
- `closed`

Referenced models: Retrieves the DS profile for a user specified by ID — response body — users item memberships item, Delete user identities for a specified identity provider — response body — identities item

Retrieves the DS profile for a user specified by ID — response body — users item memberships item

FieldTypePresenceDescription and constraints
$objectRootInformation about group membership.
account_idstringOptionalThe ID of the account.
Format: uuid
account_namestringOptionalThe name of the account.
created_onstringOptionalThe date the user's account was created.
Format: date-time
emailstringOptionalThe email address.
external_account_idstringOptionalThe external account ID.
groupsarrayOptionalA list of groups the user is a member of in this account,
groups[]ModelEach itemExpand Returns the list of groups in an account — response body — groups item
idstringOptionalFormat: uuid
is_adminbooleanOptionalWhen **true,**
the user has administration
privileges on the account.
is_external_accountbooleanOptionalWhen **true,**
this is an external account.
license_typestringOptional
permission_profileModelOptionalExpand Returns the list of permission profiles in an account — response body — permissions item
The user's permission profile.
plan_namestringOptional
statusstringOptionalThe status of the user's membership.
subscription_idstringOptional

Referenced models: Returns the list of groups in an account — response body — groups item, Returns the list of permission profiles in an account — response body — permissions item

Returns a list of DS Groups — response body

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
ds_groupsarrayOptionalRead only: true
ds_groups[]ModelEach itemExpand Creates a new DS Group — response body
pageJSONOptional
page (anyOf 1)integerAlternativeThe page number.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page_sizeJSONOptional
page_size (anyOf 1)integerAlternativeThe number of items per page.
Format: int32
page_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_countJSONOptional
total_count (anyOf 1)integerAlternativeFormat: int32
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Creates a new DS Group — response body

Returns a list of organizations that the authenticated user belongs to — response body

FieldTypePresenceDescription and constraints
$objectRootOrganization list.
organizationsarrayOptionalA list of organizations of which the authenticated user is a member.
organizations[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item

Referenced models: Returns a list of organizations that the authenticated user belongs to — response body — organizations item

Returns a list of organizations that the authenticated user belongs to — response body — organizations item

FieldTypePresenceDescription and constraints
$objectRootInformation about an individual organization.
accountsarrayOptionalA list of organization accounts.
accounts[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item accounts item
created_bystringOptionalThe user who created the organization account.
Format: uuid
created_onstringOptionalThe date the organization's account was created.
Format: date-time
default_account_idstringOptionalThe default account ID of the organization.
Format: uuid
default_permission_profile_idJSONOptional
default_permission_profile_id (anyOf 1)integerAlternativeThe default permission profile ID of the organization.
Format: int64
default_permission_profile_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
descriptionstringOptionalA description of the organization.
idstringOptionalThe ID of the organization.
Format: uuid
identity_providersarrayOptionalA list of identity providers for the organization.
identity_providers[]ModelEach itemExpand Returns the list of identity providers for an organization — response body
last_modified_bystringOptionalThe user who last updated the organization's account.
Format: uuid
last_modified_onstringOptionalThe date the organization's account was last updated.
Format: date-time
linksarrayOptionalA list of links for the organization.
links[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
namestringOptionalThe name of the organization.
reserved_domainsarrayOptionalA list of reserved domains for the organization.
reserved_domains[]ModelEach itemExpand Returns the list of reserved domains for the organization — response body — reserved domains item
usersarrayOptionalA list of the organization accounts users.
users[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item users item

Referenced models: Returns the list of reserved domains for the organization — response body — reserved domains item, Returns the list of identity providers for an organization — response body, Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item, Returns a list of organizations that the authenticated user belongs to — response body — organizations item accounts item, Returns a list of organizations that the authenticated user belongs to — response body — organizations item users item

Returns a list of organizations that the authenticated user belongs to — response body — organizations item accounts item

FieldTypePresenceDescription and constraints
$objectRootInformation about an account.
external_account_idJSONOptional
external_account_id (anyOf 1)integerAlternativeThe external account ID.
Format: int64
external_account_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringOptionalThe unique ID of the account.
Format: uuid
namestringOptionalThe name of the account.
site_idJSONOptional
site_id (anyOf 1)integerAlternativeThe site ID.
Format: int32
site_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item

FieldTypePresenceDescription and constraints
$objectRootA link to a useful URL.
hrefstringOptionalThe URL of the linked item.
relstringOptionalThe kind of linked item.

Returns a list of organizations that the authenticated user belongs to — response body — organizations item users item

FieldTypePresenceDescription and constraints
$objectRootAn ID object.
idstringOptionalThe ID.
Format: uuid

Returns a list of pending and completed export requests — response body

FieldTypePresenceDescription and constraints
$objectRoot
exportsarrayOptional
exports[]ModelEach itemExpand Creates a user list export request — response body

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

Returns information about the users in an organization — response body

FieldTypePresenceDescription and constraints
$objectRootA response containing information about users.
pagingModelOptionalExpand Returns the list of groups in an account — response body — paging
Contains information about paging through the results.
usersarrayOptionalA list of users.
users[]ModelEach itemExpand Returns information about the users in an organization — response body — users item

Referenced models: Returns information about the users in an organization — response body — users item, Returns the list of groups in an account — response body — paging

Returns information about the users in an organization — response body — users item

FieldTypePresenceDescription and constraints
$objectRootInformation about a user.
closed_onstringOptionalFormat: date-time
created_onstringOptionalThe date the user's account was created.
Format: date-time
ds_groupsarrayOptional
ds_groups[]ModelEach itemExpand Creates a new DS Group — response body
emailstringOptionalThe email address.
first_namestringOptionalThe user's first name.
idstringOptionalThe user's unique ID.
Format: uuid
is_managed_by_scimbooleanOptional
is_membership_managed_by_scimbooleanOptional
last_namestringOptionalThe user's last name.
license_typestringOptional
membership_closed_onstringOptionalFormat: date-time
membership_created_onstringOptionalThe date on which the user became a member of the organization.
Format: date-time
membership_idstringOptionalFormat: uuid
membership_statusstringOptionalThe user's membership status. One of:

- `activation_required`
- `activation_sent`
- `active`
- `closed`
- `disabled`
plan_namestringOptional
subscription_idstringOptional
user_namestringOptionalThe full name of the user.
user_statusstringOptionalThe user's status. One of:

- `active`
- `created`
- `closed`

Referenced models: Creates a new DS Group — response body

Returns the list of groups in an account — response body

FieldTypePresenceDescription and constraints
$objectRootA response about member groups. It contains the groups and paging information.
groupsarrayOptionalA list of the responses.
groups[]ModelEach itemExpand Returns the list of groups in an account — response body — groups item
pagingModelOptionalExpand Returns the list of groups in an account — response body — paging
Information about paging though the responses.

Referenced models: Returns the list of groups in an account — response body — groups item, Returns the list of groups in an account — response body — paging

Returns the list of groups in an account — response body — groups item

FieldTypePresenceDescription and constraints
$objectRootAnd individual group responses,.
idJSONOptional
id (anyOf 1)integerAlternativeThe unique ID of the group.
Format: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalThe name of the group.
typestringOptionalThe type of group. One of:

- `invalid`
- `admin_group`
- `everyone_group`
- `custom_group`

Returns the list of groups in an account — response body — paging

FieldTypePresenceDescription and constraints
$objectRoot
nextstringOptionalA URL to the next set of results.
previousstringOptionalA URL to the previous set of results.
result_set_end_positionJSONOptional
result_set_end_position (anyOf 1)integerAlternativeThe index position of the last result in this set.
Format: int32
result_set_end_position (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
result_set_sizeJSONOptional
result_set_size (anyOf 1)integerAlternativeThe number of items in a result set (page).
Format: int32
result_set_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
result_set_start_positionJSONOptional
result_set_start_position (anyOf 1)integerAlternativeThe index position of the first result in this set.
Format: int32
result_set_start_position (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_set_sizeJSONOptional
total_set_size (anyOf 1)integerAlternativeThe total number of results.
Format: int32
total_set_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Returns the list of identity providers for an organization — response body

FieldTypePresenceDescription and constraints
$objectRoot
identity_providersarrayOptional
identity_providers[]ModelEach itemExpand Returns the list of identity providers for an organization — response body — identity providers item

Referenced models: Returns the list of identity providers for an organization — response body — identity providers item

Returns the list of identity providers for an organization — response body — identity providers item

FieldTypePresenceDescription and constraints
$objectRootInformation about a single identity provider.
auto_provision_usersbooleanOptionalWhen **true,** users who use this identity provider are automatically provisioned.
friendly_namestringOptionalThe human-readable name of the identity provider.
idstringOptionalThe unique ID of the identity provider.
Format: uuid
linksarrayOptionalA list of useful URLs.
links[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
saml_20ModelOptionalExpand Returns the list of identity providers for an organization — response body — identity providers item saml 20
If `type` is `saml_20`, contains details about the SAML 2.0 response.
typestringOptionalThe type of the identity provider. One of:

- `none`
- `saml_20`
- `saml_11`
- `saml_10`
- `ws_federation`
- `open_id_connect`

Referenced models: Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item, Returns the list of identity providers for an organization — response body — identity providers item saml 20

Returns the list of identity providers for an organization — response body — identity providers item saml 20

FieldTypePresenceDescription and constraints
$objectRootInformation about a SAML 2.0 identity provider.
attribute_mappingsarrayOptionalA list of attribute mappings.
attribute_mappings[]ModelEach itemExpand Returns the list of identity providers for an organization — response body — identity providers item saml 20 attribute mappings item
certificatesarrayOptionalA list of certificates responses.
certificates[]ModelEach itemExpand Returns the list of identity providers for an organization — response body — identity providers item saml 20 certificates item
issuerstringOptionalThe name of the certificate issuer.
settingsarrayOptionalA list of settings.
settings[]ModelEach itemExpand Returns the list of reserved domains for the organization — response body — reserved domains item settings item

Referenced models: Returns the list of identity providers for an organization — response body — identity providers item saml 20 certificates item, Returns the list of identity providers for an organization — response body — identity providers item saml 20 attribute mappings item, Returns the list of reserved domains for the organization — response body — reserved domains item settings item

Returns the list of identity providers for an organization — response body — identity providers item saml 20 attribute mappings item

FieldTypePresenceDescription and constraints
$objectRootA single attribute mapping response.
required_attribute_friendly_namestringOptionalThe human-readable name of the attribute.
required_attribute_idJSONOptional
required_attribute_id (anyOf 1)integerAlternativeThe unique ID of the attribute.
Format: int32
required_attribute_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
required_attribute_namestringOptionalThe name of the attribute.
substitute_attribute_namestringOptionalThe name of the substitute attribute.

Returns the list of identity providers for an organization — response body — identity providers item saml 20 certificates item

FieldTypePresenceDescription and constraints
$objectRootInformation about a single certificate.
expiration_datestringOptionalThe date when the certificate expires.
Format: date-time
idstringOptionalThe unique ID of the certificate.
Format: uuid
is_validbooleanOptionalWhen **true,** the certificate is valid.
Read only: true
issuerstringOptionalThe certificate issuer.
linksarrayOptionalA list of useful links.
links[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
thumbprintstringOptionalThe thumbprint of the certificate.

Referenced models: Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item

Returns the list of permission profiles in an account — response body

FieldTypePresenceDescription and constraints
$objectRootA list of permission profiles for a given account.
permissionsarrayOptionalAn array of permission profile responses.
permissions[]ModelEach itemExpand Returns the list of permission profiles in an account — response body — permissions item

Referenced models: Returns the list of permission profiles in an account — response body — permissions item

Returns the list of permission profiles in an account — response body — permissions item

FieldTypePresenceDescription and constraints
$objectRootThis object is an individual permission profile response.
idJSONOptional
id (anyOf 1)integerAlternativeThe ID of the permission profile.
Format: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalThe name of the permission profile.

Example: `DocuSign Sender`

Returns the list of reserved domains for the organization — response body

FieldTypePresenceDescription and constraints
$objectRootA response about reserved domains.
reserved_domainsarrayOptionalInformation about reserved domains.
reserved_domains[]ModelEach itemExpand Returns the list of reserved domains for the organization — response body — reserved domains item

Referenced models: Returns the list of reserved domains for the organization — response body — reserved domains item

Returns the list of reserved domains for the organization — response body — reserved domains item

FieldTypePresenceDescription and constraints
$objectRootInformation about a reserved domain.
host_namestringOptionalThe host name of the reserved domain.
idstringOptionalThe ID of the reserved domain.
Format: uuid
identity_provider_idstringOptionalThe identity provider ID of the reserved domain.
Format: uuid
linksarrayOptionalA list of useful links.
links[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
settingsarrayOptionalA list of settings for the reserved domain.
settings[]ModelEach itemExpand Returns the list of reserved domains for the organization — response body — reserved domains item settings item
statusstringOptionalThe status of the request. One of:

- `unknown`
- `pending`
- `active`
- `deactivated`
- `rejected`
txt_tokenstringOptionalA token in form of text of the reserved domain.

Referenced models: Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item, Returns the list of reserved domains for the organization — response body — reserved domains item settings item

Returns the list of reserved domains for the organization — response body — reserved domains item settings item

FieldTypePresenceDescription and constraints
$objectRootA key/value list of settings.
keystringOptionalThe key of the setting.
typestringOptionalThe type of the setting. One of:

- `unknown`
- `guid`
- `text`
- `integer`
- `boolean`
- `datetime`
- `enumeration`
valueobjectOptionalThe value of the setting.

Revokes a user's access to one or more products — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
product_idsarrayRequired within parentA list of IDs corresponding to the products for which the user's access will be revoked.

For example:

`["230546a7-xxxx-xxxx-xxxx-af205d5494ad", "984800b7-xxxx-xxxx-xxxx-kt374a5922lk"]`
product_ids[]stringEach itemFormat: uuid
user_emailstringOptionalThe user's email address.
user_idstringOptionalThe user's unique ID.
Format: uuid

Revokes a user's access to one or more products — response body

FieldTypePresenceDescription and constraints
$objectRoot
is_successbooleanRequired within parentWhen **true,** indicates that the user's access to the specified products was successfully revoked.
user_emailstringOptionalThe user's email address.
user_idstringOptionalThe user's ID.
Format: uuid
user_product_resultsobjectRequired within parentThe results of the request to revoke product access.

Each key in the object is the ID of a product specified in the request. Each corresponding value indicates whether the user's access for that product was successfully revoked. If successful, the value is `deleted`. Otherwise, the value describes the error that occurred.

For example:
```
{
"230546a7-xxxx-xxxx-xxxx-af205d5494ad"": "deleted",
"984800b7-xxxx-xxxx-xxxx-kt374a5922lk": "Invalid product id"
}
```
Additional keys: see wildcard field
user_product_results.*stringAdditional keys

Updates a user's email address — request body — body

FieldTypePresenceDescription and constraints
$objectRootA change email request.
usersarrayOptionalA list of users whose email address to change.
users[]ModelEach itemExpand Updates a user's email address — request body — body users item

Referenced models: Updates a user's email address — request body — body users item

Updates a user's email address — request body — body users item

FieldTypePresenceDescription and constraints
$objectRootAnd individual change of email.
emailstringRequired within parentThe new email address.
idstringRequired within parentThe ID of the users whose email address you want to change.
Format: uuid
site_idintegerRequired within parentThe site ID.
Format: int32

Updates a user's email address — response body

FieldTypePresenceDescription and constraints
$objectRootThe results of changing a user's information.
successbooleanOptionalWhen **true,** the request to change user information succeeded.
usersarrayOptionalA list of users whose email addresses have been updated.
users[]ModelEach itemExpand Updates a user's email address — response body — users item

Referenced models: Updates a user's email address — response body — users item

Updates a user's email address — response body — users item

FieldTypePresenceDescription and constraints
$objectRootError result of attempting to change a user's email address.
emailstringOptionalThe email address.
error_detailsModelOptionalExpand Updates a user's email address — response body — users item error details
Error results.
idstringOptionalThe ID of the user whose email address has been updated.
Format: uuid
site_idJSONOptional
site_id (anyOf 1)integerAlternativeThe site ID.
Format: int32
site_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Updates a user's email address — response body — users item error details

Updates a user's email address — response body — users item error details

FieldTypePresenceDescription and constraints
$objectRootErrors.
errorstringOptionalThe code for the error.
error_descriptionstringOptionalA description of the error.

admin:Organization Connect Get Organization Connect Config — response body

FieldTypePresenceDescription and constraints
$objectRoot
accountIdsarrayOptional
accountIds[]stringEach item
allowEnvelopePublishstringOptional
associatedFilterSelectionstringOptional
configurationTypestringOptional
connectIdstringOptionalFormat: uuid
deliveryModestringOptional
eventDataModelOptionalExpand admin:Organization Connect Get Organization Connect Config — response body — event Data
eventsarrayOptional
events[]stringEach item
groupIdsarrayOptional
groupIds[]stringEach item
includeHMACstringOptional
includeOAuthstringOptional
namestringOptional
pausePublishstringOptional
signMessageWithX509CertificatestringOptional
urlToPublishTostringOptional
userIdsarrayOptional
userIds[]stringEach item

Referenced models: admin:Organization Connect Get Organization Connect Config — response body — event Data

admin:Organization Connect Get Organization Connect Config — response body — event Data

FieldTypePresenceDescription and constraints
$objectRoot
includeDataarrayOptional
includeData[]stringEach item
versionstringOptional

admin:Organization Connect Get Organization Connect Configs — response body

FieldTypePresenceDescription and constraints
$objectRoot
configurationsarrayOptional
configurations[]ModelEach itemExpand admin:Organization Connect Get Organization Connect Configs — response body — configurations item
errorDetailModelOptionalExpand admin:Organization Connect Get Organization Connect Configs — response body — error Detail
totalSetSizeJSONOptional
totalSetSize (anyOf 1)integerAlternativeFormat: int32
totalSetSize (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: admin:Organization Connect Get Organization Connect Configs — response body — error Detail, admin:Organization Connect Get Organization Connect Configs — response body — configurations item

admin:Organization Connect Get Organization Connect Configs — response body — configurations item

FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringOptionalThe account ID GUID.
accountNamestringOptionalThe account name of the asset group account.
allowEnvelopePublishstringOptional
allowSalesforcePublishstringOptional
configurationTypestringOptional
connectIdstringOptional
disabledBystringOptional
namestringOptional
pausePublishstringOptional
requiresAcknowledgementstringOptional
siteIdJSONOptional
siteId (anyOf 1)integerAlternativeThe site ID of the account.

Format: int32
siteId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

admin:Organization Connect Get Organization Connect Configs — response body — error Detail

FieldTypePresenceDescription and constraints
$objectRoot
errorMessagestringOptional
referenceIdstringOptional

admin:Organization Connect Hmac Get Connect Hmac Secrets — response body

FieldTypePresenceDescription and constraints
$objectRoot
secretsarrayOptional
secrets[]stringEach item

admin:Organization Connect O Auth Configuration Put Organization Connect O Auth Configuration — response body

FieldTypePresenceDescription and constraints
$objectRoot
authorizationServerUrlstringOptionalFormat: uri
clientIdstringOptional
clientSecretstringOptional
customParameterobjectOptionalAdditional keys: see wildcard field
customParameter.*stringAdditional keys
scopestringOptional

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.