DocuSign: Admin schemas
101 DocuSign schemas with complete fields and constraints.
← Admin operations · All schemas
Activates user memberships — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
site_id | integer | Required within parent | Format: int32 |
Activates user memberships — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A response. |
status | string | Optional | The status of the request. |
Adds a list of users to a DS Group — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
user_ids | array | Required within parent | |
user_ids[] | string | Each item | Format: uuid |
Adds a list of users to a DS Group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
group | Model | Optional | Expand Creates a new DS Group — response body |
group_users | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
TotalCount | JSON | Optional | |
TotalCount (anyOf 1) | integer | Alternative | Format: int32 |
TotalCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
is_success | boolean | Optional | |
users | array | Optional | A list of users. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of accounts to close for a user. |
accounts | array | Required within parent | A list of accounts to close for a user. |
accounts[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The ID of a user's account you want to close. Format: uuid |
Closes a user's memberships — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The results of closing a user's account. |
accounts | array | Optional | A list of accounts that were closed. |
accounts[] | Model | Each item | Expand Closes a user's memberships — response body — accounts item |
success | boolean | Optional | When **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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Results of closing accounts. |
error_details | Model | Optional | Expand Updates a user's email address — response body — users item error details Error results. |
id | string | Optional | The 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
| 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 — 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 — 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 — 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. |
Creates a new DS Group — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Optional | |
group_name | string | Required within parent |
Creates a new DS Group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Optional | Select 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_name | string | Optional | |
description | string | Optional | |
ds_group_id | string | Optional | Format: uuid |
external_account_id | JSON | Optional | |
external_account_id (anyOf 1) | integer | Alternative | Format: int64 |
external_account_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
group_id | string | Optional | |
group_name | string | Optional | |
is_admin | boolean | Optional | |
is_managed_by_scim | boolean | Optional | |
last_modified_on | string | Optional | Format: date-time |
source_product_name | string | Optional | |
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]+)?$ |
Creates a new account settings export request — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounts | array | Optional | |
accounts[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Required within parent | Select 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completed | string | Optional | Format: date-time |
created | string | Optional | Format: date-time |
expires | string | Optional | Format: date-time |
id | string | Optional | |
last_modified | string | Optional | Format: date-time |
number_processed_accounts | JSON | Optional | |
number_processed_accounts (anyOf 1) | integer | Alternative | Format: int64 |
number_processed_accounts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_unprocessed_accounts | JSON | Optional | |
number_unprocessed_accounts (anyOf 1) | integer | Alternative | Format: int64 |
number_unprocessed_accounts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
organization_id | string | Optional | |
percent_completed | JSON | Optional | |
percent_completed (anyOf 1) | integer | Alternative | Format: int32 |
percent_completed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestor | Model | Optional | Expand Creates a new account settings import request — response body — requestor |
results | array | Optional | |
results[] | Model | Each item | Expand Creates a new account settings import request — response body — results item |
skipped_settings_by_account | object | Optional | Additional keys: see wildcard field |
skipped_settings_by_account.* | array | Additional keys | |
skipped_settings_by_account.*[] | string | Each item | |
status | string | Optional | Status. |
success | boolean | Optional | |
type | string | Optional |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | The email address. |
id | string | Optional | |
name | string | Optional | |
type | string | Optional |
Creates a new account settings import request — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_details | Model | Optional | Expand Creates a user list export request — response body — results item error details Error results. |
id | string | Optional | Format: uuid |
number_processed_accounts | JSON | Optional | |
number_processed_accounts (anyOf 1) | integer | Alternative | Format: int64 |
number_processed_accounts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_unprocessed_accounts | JSON | Optional | |
number_unprocessed_accounts (anyOf 1) | integer | Alternative | Format: int64 |
number_unprocessed_accounts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
processing_issues_by_account | array | Optional | |
processing_issues_by_account[] | Model | Each item | Expand Creates a new account settings import request — response body — results item processing issues by account item |
site_id | JSON | Optional | |
site_id (anyOf 1) | integer | Alternative | Format: int32 |
site_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
url | string | Optional |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Optional | Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified. |
account_name | string | Optional | |
error | string | Optional | The error number. |
error_key | string | Optional | |
setting_key | string | Optional |
Creates a user list export request — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Enables you to specify the kind of export request. |
accounts | array | Optional | |
accounts[] | Model | Each item | Expand Creates a user list export request — response body — selected accounts item |
domains | array | Optional | |
domains[] | Model | Each item | Expand Creates a user list export request — response body — selected domains item |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completed | string | Optional | The time and date when the request completed. Null if the request is still in progress. Format: date-time |
created | string | Optional | The 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 |
expires | string | Optional | The time and date when the request expires. Format: date-time |
id | string | Optional | The unique ID of this request. Format: uuid |
last_modified | string | Optional | The time and date when the request was modified. This is typically the same as `created`. Format: date-time |
metadata_url | string | Optional | A pre-configured GET request to get the status of the export. Generally this is the same URI used to access this endpoint. |
number_rows | JSON | Optional | |
number_rows (anyOf 1) | integer | Alternative | The number of rows returned in this request. Format: int64 |
number_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
percent_completed | JSON | Optional | |
percent_completed (anyOf 1) | integer | Alternative | An integer between 0 to 100 (inclusive) that reports the progress of the request. Format: int32 |
percent_completed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestor | Model | Optional | Expand Closes external memberships — response body — requestor The user who initiated the request. |
results | array | Optional | An array of results. There is one set of results for each server an account is in. |
results[] | Model | Each item | Expand Creates a user list export request — response body — results item |
selected_accounts | array | Optional | |
selected_accounts[] | Model | Each item | Expand Creates a user list export request — response body — selected accounts item |
selected_domains | array | Optional | |
selected_domains[] | Model | Each item | Expand Creates a user list export request — response body — selected domains item |
size_bytes | JSON | Optional | |
size_bytes (anyOf 1) | integer | Alternative | The size of the request in bytes. Format: int64 |
size_bytes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
status | string | Optional | The status of the request. One of: - `failed` - `in_process` - `queued` - `completed` |
success | boolean | Optional | When **true,** the request succeeded. |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_details | Model | Optional | Expand Creates a user list export request — response body — results item error details Error results. |
id | string | Optional | The unique ID of the task request. Format: uuid |
number_rows | JSON | Optional | |
number_rows (anyOf 1) | integer | Alternative | The number of rows returned in the result. Format: int64 |
number_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
site_id | JSON | Optional | |
site_id (anyOf 1) | integer | Alternative | The ID of the site the response is for. Format: int32 |
site_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
size_bytes | JSON | Optional | |
size_bytes (anyOf 1) | integer | Alternative | The size of the response in bytes. Format: int64 |
size_bytes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
url | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | string | Optional | The error number. |
error_description | string | Optional | A longer description of the error. |
Creates a user list export request — response body — selected accounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Optional | Select 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
domain | string | Optional |
Delete user identities for a specified identity provider — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request to delete a user's identities, |
identities | array | Required within parent | A list of identities. |
identities[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User identity, |
id | string | Optional | The `provider_id` that is returned from calling `getUserProfiles`. Format: uuid |
Delete user identities for a specified identity provider — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Results of deleting identities. |
identities | array | Optional | A list of identities to delete. |
identities[] | Model | Each item | Expand Delete user identities for a specified identity provider — response body — identities item |
success | boolean | Optional | When **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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Results of deleting a user identity. |
error_details | Model | Optional | Expand Updates a user's email address — response body — users item error details Error results. |
id | string | Optional | The ID of the result. Format: uuid |
immutable_id | string | Optional | A unique ID to identify the removed user. |
provider_id | string | Optional | The ID of the identity provider. Format: uuid |
user_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
memberships | array | Optional | A list of accounts from which you want to delete the user's data. At least one account is required. |
memberships[] | Model | Each item | Expand Deletes data for one or more of a user's account memberships — request body — body memberships item |
user_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
user_id | string | Optional | The ID of the user whose data you want to delete. Format: uuid |
Deletes membership data for a user on an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
membership_results | array | Optional | A list of objects describing the status of the deletion request for each account. Read only: true |
membership_results[] | Model | Each item | Expand Deletes membership data for a user on an account — response body — membership results item |
status | string | Optional | The overall status of the data deletion request. Known values: unknown, pending, failure, success, already_redacted Read only: true |
user_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object describing the status of the data deletion request for a specific account. |
account_id | string | Optional | The ID of the account. Format: uuid Read only: true |
status | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assetGroupId | string | Optional | The ID of the asset group to which the accounts belong. Format: uuid Read only: true |
assetGroupWorkId | string | Optional | The ID of the job that is created by the request. Format: uuid Read only: true |
assetGroupWorkType | string | Optional | The type of asset group work. This property is read-only. Known values: Undefined, GroupAssetFulfillment, AccountAssetFulfillment, AccountAssetClone, AccountAssetCreate, SubscriptionSync Read only: true |
attempts | JSON | Optional | |
attempts (anyOf 1) | integer | Alternative | The number of times the job has been attempted. Format: int32 Read only: true |
attempts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
createAccountProcessingFailureDetails | Model | Optional | Expand 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 |
createdByEmail | string | Optional | The email of the creator of the account clone work. Read only: true |
createdByName | string | Optional | The name of the creator of the account clone work. Read only: true |
createdDate | string | Optional | The date the account clone work is created. Format: date-time Read only: true |
message | string | Optional | The message associated with the account clone work. Read only: true |
orderId | string | Optional | The order ID created by the clone work. Format: uuid Read only: true |
status | string | Optional | The status of the account creation request. Known values: Undefined, Pending, Processing, ProcessingOnHold, PendingError, ProcessingError, Completed, Canceled, PermanentFailure Read only: true |
subscriptionDetails | Model | Required within parent | Expand Get a single account creation process — response body — subscription Details The subscription info for the new account. |
targetAccount | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Subscription ID |
modules | array | Optional | List of module IDs selected for creating the new account |
modules[] | Model | Each item | Expand Get a single account creation process — response body — subscription Details modules item |
planId | string | Optional | Plan ID Format: uuid |
planName | string | Optional | Plan 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
moduleId | string | Optional | Module ID Format: uuid |
moduleName | string | Optional | Module name |
Get a single account creation process — response body — target Account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
admin | Model | Optional | Expand Get a single account creation process — response body — target Account admin The admin user for the target account. |
countryCode | string | Optional | The country code where the target account is in. This value is ignored if region is provided. |
id | string | Optional | The account ID of the new account. The GUID will be empty if the account has not been created yet. Format: uuid |
name | string | Optional | The name of the target account. |
region | string | Optional | The region where the target account is in. |
site | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | The email address of the target account's admin user. |
firstName | string | Optional | |
lastName | string | Optional | |
locale | string | Optional | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assetGroupWorks | array | Optional | The list of asset group accounts. Read only: true |
assetGroupWorks[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of asset group accounts. |
assetGroupAccounts | array | Optional | The list of asset group accounts. Read only: true |
assetGroupAccounts[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | string | Optional | The ID of the account. Format: uuid Read only: true |
accountName | string | Optional | The name of the account. Read only: true |
assetGroupId | string | Optional | The asset group ID. Format: uuid Read only: true |
assetGroupName | string | Optional | Reserved for Docusign. Read only: true |
compliant | boolean | Optional | When **true,** indicates that the account is compliant. Read only: true |
externalAccountId | JSON | Optional | |
externalAccountId (anyOf 1) | integer | Alternative | The external account ID. Format: int64 Read only: true |
externalAccountId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
siteId | JSON | Optional | |
siteId (anyOf 1) | integer | Alternative | Reserved for Docusign. Format: int32 Read only: true |
siteId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
siteName | string | Optional | Reserved for Docusign. Read only: true |
Get information about plan items within an organization — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
asset_group_id | string | Optional | Format: uuid |
asset_group_name | string | Optional | |
associated_accounts_count | JSON | Optional | |
associated_accounts_count (anyOf 1) | integer | Alternative | Format: int32 |
associated_accounts_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
modules | array | Optional | List of module IDs selected for creating the new account |
modules[] | Model | Each item | Expand Get information about plan items within an organization — response body — item modules item |
plan_id | string | Optional | Format: uuid |
plan_name | string | Optional | |
subscription_id | string | Optional | |
subscription_name | string | Optional |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
plan_item_description | string | Optional | |
plan_item_id | string | Optional | Format: uuid |
plan_item_internal_id | string | Optional | |
plan_item_name | string | Optional |
Gets a list of all of the user import requests — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
imports | array | Optional | A list of responses to user import requests. |
imports[] | Model | Each item | Expand Closes external memberships — response body |
Referenced models: Closes external memberships — response body
Gets a list of users in a DS Group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
group | Model | Optional | Expand Creates a new DS Group — response body |
group_users | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
page | JSON | Optional | |
page (anyOf 1) | integer | Alternative | The page number. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
page_size | JSON | Optional | |
page_size (anyOf 1) | integer | Alternative | The number of items per page. Format: int32 |
page_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_count | JSON | Optional | |
total_count (anyOf 1) | integer | Alternative | Format: int32 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
users | array | Optional | A list of users. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assetGroupWorks | array | Optional | The list of asset group accounts. Read only: true |
assetGroupWorks[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The account that is cloned. |
assetGroupId | string | Optional | The 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 |
assetGroupWorkId | string | Optional | The 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 |
assetGroupWorkType | string | Optional | The type of asset group work. This property is read-only. Known values: Undefined, GroupAssetFulfillment, AccountAssetFulfillment, AccountAssetClone, AccountAssetCreate, SubscriptionSync Read only: true |
attempts | JSON | Optional | |
attempts (anyOf 1) | integer | Alternative | The number of retries. This property is read-only. Format: int32 Read only: true |
attempts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cloneProcessingFailureDetails | Model | Optional | Expand 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 |
cloneRequestId | string | Optional | Reserved for Docusign. Format: uuid Read only: true |
createdByEmail | string | Optional | The email address of the user who initiated the clone request. This property is read-only. Read only: true |
createdByName | string | Optional | The name of the user who initiated the clone request. This property is read-only. Read only: true |
createdDate | string | Optional | The date that the clone request was initiated. This property is read-only. Format: date-time Read only: true |
message | string | Optional | A 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 |
orderId | string | Optional | Reserved for Docusign. Format: uuid Read only: true |
sourceAccount | Model | Required within parent | Expand Gets information about a single cloned account — response body — source Account The source account that is cloned. |
status | string | Optional | The 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 |
targetAccount | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | string | Optional | The error code. Read only: true |
errorDescription | string | Optional | The error description. Read only: true |
isSystemError | boolean | Optional | Whether the error is caused by the system or user. Read only: true |
Gets information about a single cloned account — response body — source Account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
externalAccountId | JSON | Optional | |
externalAccountId (anyOf 1) | integer | Alternative | The external account ID of the source account. Format: int64 Read only: true |
externalAccountId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | The ID of the account to clone. This property is required in POST requests. Format: uuid |
name | string | Optional | The name of the source account. Read only: true |
site | string | Optional | The site the source account is on. Read only: true |
Gets information about a single cloned account — response body — target Account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object describing the target cloned account. |
admin | Model | Optional | Expand 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. |
countryCode | string | Optional | The 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. |
id | string | Optional | The ID of the target account. This property is read-only. Format: uuid |
name | string | Optional | The name of the target account. This property is required in the request body when cloning an account. |
region | string | Optional | The 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. |
site | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object describing the administrator of the cloned account. |
email | string | Optional | The email address of the target account administrator. This property is required in the request body when cloning an account. |
firstName | string | Optional | The first name of the target account administrator. This property is required in the request body when cloning an account. |
lastName | string | Optional | The last name of the target account administrator. This property is required in the request body when cloning an account. |
locale | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about users to remove from the group. |
user_emails | array | Optional | An 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[] | string | Each item | |
user_ids | array | Optional | An array of IDs corresponding to users to remove from the group. |
user_ids[] | string | Each item | Format: uuid |
Removes a list of users from a DS Group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
failed_users | array | Optional | |
failed_users[] | Model | Each item | Expand Removes a list of users from a DS Group — response body — failed users item |
is_success | boolean | Optional |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Optional | Select 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_details | Model | Optional | Expand Updates a user's email address — response body — users item error details Error results. |
first_name | string | Optional | The user's first name. |
last_name | string | Optional | The user's last name. |
middle_name | string | Optional | |
status | string | Optional | Status. |
user_id | string | Optional | Format: uuid |
user_name | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Optional | The ID of the account. Format: uuid |
product_permission_profiles | array | Optional | A list of one or more products and their respective permissions. |
product_permission_profiles[] | Model | Each item | Expand Retrieves a user's product permission profiles by user ID — response body — product permission profiles item |
user_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
product_permission_profiles | array | Optional | A list of one or more products and their respective permissions. Read only: true |
product_permission_profiles[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Optional | |
permission_profiles | array | Optional | |
permission_profiles[] | Model | Each item | Expand Retrieves a user's product permission profiles by user ID — response body — product permission profiles item permission profiles item |
product_id | string | Optional | The ID of the product. Format: uuid |
product_name | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
permission_profile_id | string | Optional | The ID of the permission profile. |
permission_profile_name | string | Optional | The human-readable name of the permission profile. |
Retrieves the DS profile for a user specified by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a list of users. |
users | array | Optional | A list of users. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a user. |
allow_extend_org_admin_rights_to_self | boolean | Optional | |
allow_two_step_verification_snooze | boolean | Optional | |
created_on | string | Optional | The date the user's account was created. Format: date-time |
default_account_id | string | Optional | The ID of the user's default account. Format: uuid |
default_account_name | string | Optional | The name of the user's default account. |
device_verification_enabled | boolean | Optional | |
federated_status | string | Optional | The user's federated status. One of: - `RemoveStatus` - `FedAuthRequired` - `FedAuthBypass` - `Evicted` |
first_name | string | Optional | The user's first name. |
id | string | Optional | The user's unique ID. Format: uuid |
identities | array | Optional | A list of identities associated with the user. |
identities[] | Model | Each item | Expand Delete user identities for a specified identity provider — response body — identities item |
is_managed_by_scim | boolean | Optional | |
is_organization_admin | boolean | Optional | When **true,** the user has organization administration privileges. |
language_culture | string | Optional | The 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_login | string | Optional | This property has been deprecated. Format: date-time |
last_name | string | Optional | The user's last name. |
memberships | array | Optional | A list of organizations that have groups that the user is a member of. |
memberships[] | Model | Each item | Expand Retrieves the DS profile for a user specified by ID — response body — users item memberships item |
require_two_step_verification | boolean | Optional | |
selected_languages | string | Optional | |
site_id | JSON | Optional | |
site_id (anyOf 1) | integer | Alternative | The site ID of the organization. Format: int32 |
site_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
site_name | string | Optional | The site name of the account. |
user_name | string | Optional | The full name of the user. |
user_status | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about group membership. |
account_id | string | Optional | The ID of the account. Format: uuid |
account_name | string | Optional | The name of the account. |
created_on | string | Optional | The date the user's account was created. Format: date-time |
email | string | Optional | The email address. |
external_account_id | string | Optional | The external account ID. |
groups | array | Optional | A list of groups the user is a member of in this account, |
groups[] | Model | Each item | Expand Returns the list of groups in an account — response body — groups item |
id | string | Optional | Format: uuid |
is_admin | boolean | Optional | When **true,** the user has administration privileges on the account. |
is_external_account | boolean | Optional | When **true,** this is an external account. |
license_type | string | Optional | |
permission_profile | Model | Optional | Expand Returns the list of permission profiles in an account — response body — permissions item The user's permission profile. |
plan_name | string | Optional | |
status | string | Optional | The status of the user's membership. |
subscription_id | string | Optional |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Optional | Select 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_groups | array | Optional | Read only: true |
ds_groups[] | Model | Each item | Expand Creates a new DS Group — response body |
page | JSON | Optional | |
page (anyOf 1) | integer | Alternative | The page number. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
page_size | JSON | Optional | |
page_size (anyOf 1) | integer | Alternative | The number of items per page. Format: int32 |
page_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_count | JSON | Optional | |
total_count (anyOf 1) | integer | Alternative | Format: int32 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Organization list. |
organizations | array | Optional | A list of organizations of which the authenticated user is a member. |
organizations[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about an individual organization. |
accounts | array | Optional | A list of organization accounts. |
accounts[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item accounts item |
created_by | string | Optional | The user who created the organization account. Format: uuid |
created_on | string | Optional | The date the organization's account was created. Format: date-time |
default_account_id | string | Optional | The default account ID of the organization. Format: uuid |
default_permission_profile_id | JSON | Optional | |
default_permission_profile_id (anyOf 1) | integer | Alternative | The default permission profile ID of the organization. Format: int64 |
default_permission_profile_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
description | string | Optional | A description of the organization. |
id | string | Optional | The ID of the organization. Format: uuid |
identity_providers | array | Optional | A list of identity providers for the organization. |
identity_providers[] | Model | Each item | Expand Returns the list of identity providers for an organization — response body |
last_modified_by | string | Optional | The user who last updated the organization's account. Format: uuid |
last_modified_on | string | Optional | The date the organization's account was last updated. Format: date-time |
links | array | Optional | A list of links for the organization. |
links[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item |
name | string | Optional | The name of the organization. |
reserved_domains | array | Optional | A list of reserved domains for the organization. |
reserved_domains[] | Model | Each item | Expand Returns the list of reserved domains for the organization — response body — reserved domains item |
users | array | Optional | A list of the organization accounts users. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about an account. |
external_account_id | JSON | Optional | |
external_account_id (anyOf 1) | integer | Alternative | The external account ID. Format: int64 |
external_account_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Optional | The unique ID of the account. Format: uuid |
name | string | Optional | The name of the account. |
site_id | JSON | Optional | |
site_id (anyOf 1) | integer | Alternative | The site ID. Format: int32 |
site_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A link to a useful URL. |
href | string | Optional | The URL of the linked item. |
rel | string | Optional | The kind of linked item. |
Returns a list of organizations that the authenticated user belongs to — response body — organizations item users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An ID object. |
id | string | Optional | The ID. Format: uuid |
Returns a list of pending and completed export requests — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
exports | array | Optional | |
exports[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A response containing information about users. |
paging | Model | Optional | Expand Returns the list of groups in an account — response body — paging Contains information about paging through the results. |
users | array | Optional | A list of users. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a user. |
closed_on | string | Optional | Format: date-time |
created_on | string | Optional | The date the user's account was created. Format: date-time |
ds_groups | array | Optional | |
ds_groups[] | Model | Each item | Expand Creates a new DS Group — response body |
email | string | Optional | The email address. |
first_name | string | Optional | The user's first name. |
id | string | Optional | The user's unique ID. Format: uuid |
is_managed_by_scim | boolean | Optional | |
is_membership_managed_by_scim | boolean | Optional | |
last_name | string | Optional | The user's last name. |
license_type | string | Optional | |
membership_closed_on | string | Optional | Format: date-time |
membership_created_on | string | Optional | The date on which the user became a member of the organization. Format: date-time |
membership_id | string | Optional | Format: uuid |
membership_status | string | Optional | The user's membership status. One of: - `activation_required` - `activation_sent` - `active` - `closed` - `disabled` |
plan_name | string | Optional | |
subscription_id | string | Optional | |
user_name | string | Optional | The full name of the user. |
user_status | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A response about member groups. It contains the groups and paging information. |
groups | array | Optional | A list of the responses. |
groups[] | Model | Each item | Expand Returns the list of groups in an account — response body — groups item |
paging | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | And individual group responses,. |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | The unique ID of the group. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | The name of the group. |
type | string | Optional | The type of group. One of: - `invalid` - `admin_group` - `everyone_group` - `custom_group` |
Returns the list of groups in an account — response body — paging
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
next | string | Optional | A URL to the next set of results. |
previous | string | Optional | A URL to the previous set of results. |
result_set_end_position | JSON | Optional | |
result_set_end_position (anyOf 1) | integer | Alternative | The index position of the last result in this set. Format: int32 |
result_set_end_position (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
result_set_size | JSON | Optional | |
result_set_size (anyOf 1) | integer | Alternative | The number of items in a result set (page). Format: int32 |
result_set_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
result_set_start_position | JSON | Optional | |
result_set_start_position (anyOf 1) | integer | Alternative | The index position of the first result in this set. Format: int32 |
result_set_start_position (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_set_size | JSON | Optional | |
total_set_size (anyOf 1) | integer | Alternative | The total number of results. Format: int32 |
total_set_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Returns the list of identity providers for an organization — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
identity_providers | array | Optional | |
identity_providers[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a single identity provider. |
auto_provision_users | boolean | Optional | When **true,** users who use this identity provider are automatically provisioned. |
friendly_name | string | Optional | The human-readable name of the identity provider. |
id | string | Optional | The unique ID of the identity provider. Format: uuid |
links | array | Optional | A list of useful URLs. |
links[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item |
saml_20 | Model | Optional | Expand 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. |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a SAML 2.0 identity provider. |
attribute_mappings | array | Optional | A list of attribute mappings. |
attribute_mappings[] | Model | Each item | Expand Returns the list of identity providers for an organization — response body — identity providers item saml 20 attribute mappings item |
certificates | array | Optional | A list of certificates responses. |
certificates[] | Model | Each item | Expand Returns the list of identity providers for an organization — response body — identity providers item saml 20 certificates item |
issuer | string | Optional | The name of the certificate issuer. |
settings | array | Optional | A list of settings. |
settings[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single attribute mapping response. |
required_attribute_friendly_name | string | Optional | The human-readable name of the attribute. |
required_attribute_id | JSON | Optional | |
required_attribute_id (anyOf 1) | integer | Alternative | The unique ID of the attribute. Format: int32 |
required_attribute_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
required_attribute_name | string | Optional | The name of the attribute. |
substitute_attribute_name | string | Optional | The name of the substitute attribute. |
Returns the list of identity providers for an organization — response body — identity providers item saml 20 certificates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a single certificate. |
expiration_date | string | Optional | The date when the certificate expires. Format: date-time |
id | string | Optional | The unique ID of the certificate. Format: uuid |
is_valid | boolean | Optional | When **true,** the certificate is valid. Read only: true |
issuer | string | Optional | The certificate issuer. |
links | array | Optional | A list of useful links. |
links[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item |
thumbprint | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of permission profiles for a given account. |
permissions | array | Optional | An array of permission profile responses. |
permissions[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object is an individual permission profile response. |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | The ID of the permission profile. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | The name of the permission profile. Example: `DocuSign Sender` |
Returns the list of reserved domains for the organization — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A response about reserved domains. |
reserved_domains | array | Optional | Information about reserved domains. |
reserved_domains[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a reserved domain. |
host_name | string | Optional | The host name of the reserved domain. |
id | string | Optional | The ID of the reserved domain. Format: uuid |
identity_provider_id | string | Optional | The identity provider ID of the reserved domain. Format: uuid |
links | array | Optional | A list of useful links. |
links[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item |
settings | array | Optional | A list of settings for the reserved domain. |
settings[] | Model | Each item | Expand Returns the list of reserved domains for the organization — response body — reserved domains item settings item |
status | string | Optional | The status of the request. One of: - `unknown` - `pending` - `active` - `deactivated` - `rejected` |
txt_token | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A key/value list of settings. |
key | string | Optional | The key of the setting. |
type | string | Optional | The type of the setting. One of: - `unknown` - `guid` - `text` - `integer` - `boolean` - `datetime` - `enumeration` |
value | object | Optional | The value of the setting. |
Revokes a user's access to one or more products — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
product_ids | array | Required within parent | A 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[] | string | Each item | Format: uuid |
user_email | string | Optional | The user's email address. |
user_id | string | Optional | The user's unique ID. Format: uuid |
Revokes a user's access to one or more products — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_success | boolean | Required within parent | When **true,** indicates that the user's access to the specified products was successfully revoked. |
user_email | string | Optional | The user's email address. |
user_id | string | Optional | The user's ID. Format: uuid |
user_product_results | object | Required within parent | The 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.* | string | Additional keys |
Updates a user's email address — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A change email request. |
users | array | Optional | A list of users whose email address to change. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | And individual change of email. |
email | string | Required within parent | The new email address. |
id | string | Required within parent | The ID of the users whose email address you want to change. Format: uuid |
site_id | integer | Required within parent | The site ID. Format: int32 |
Updates a user's email address — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The results of changing a user's information. |
success | boolean | Optional | When **true,** the request to change user information succeeded. |
users | array | Optional | A list of users whose email addresses have been updated. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Error result of attempting to change a user's email address. |
email | string | Optional | The email address. |
error_details | Model | Optional | Expand Updates a user's email address — response body — users item error details Error results. |
id | string | Optional | The ID of the user whose email address has been updated. Format: uuid |
site_id | JSON | Optional | |
site_id (anyOf 1) | integer | Alternative | The site ID. Format: int32 |
site_id (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Errors. |
error | string | Optional | The code for the error. |
error_description | string | Optional | A description of the error. |
admin:Organization Connect Get Organization Connect Config — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountIds | array | Optional | |
accountIds[] | string | Each item | |
allowEnvelopePublish | string | Optional | |
associatedFilterSelection | string | Optional | |
configurationType | string | Optional | |
connectId | string | Optional | Format: uuid |
deliveryMode | string | Optional | |
eventData | Model | Optional | Expand admin:Organization Connect Get Organization Connect Config — response body — event Data |
events | array | Optional | |
events[] | string | Each item | |
groupIds | array | Optional | |
groupIds[] | string | Each item | |
includeHMAC | string | Optional | |
includeOAuth | string | Optional | |
name | string | Optional | |
pausePublish | string | Optional | |
signMessageWithX509Certificate | string | Optional | |
urlToPublishTo | string | Optional | |
userIds | array | Optional | |
userIds[] | string | Each 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeData | array | Optional | |
includeData[] | string | Each item | |
version | string | Optional |
admin:Organization Connect Get Organization Connect Configs — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
configurations | array | Optional | |
configurations[] | Model | Each item | Expand admin:Organization Connect Get Organization Connect Configs — response body — configurations item |
errorDetail | Model | Optional | Expand admin:Organization Connect Get Organization Connect Configs — response body — error Detail |
totalSetSize | JSON | Optional | |
totalSetSize (anyOf 1) | integer | Alternative | Format: int32 |
totalSetSize (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | string | Optional | The account ID GUID. |
accountName | string | Optional | The account name of the asset group account. |
allowEnvelopePublish | string | Optional | |
allowSalesforcePublish | string | Optional | |
configurationType | string | Optional | |
connectId | string | Optional | |
disabledBy | string | Optional | |
name | string | Optional | |
pausePublish | string | Optional | |
requiresAcknowledgement | string | Optional | |
siteId | JSON | Optional | |
siteId (anyOf 1) | integer | Alternative | The site ID of the account. Format: int32 |
siteId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
admin:Organization Connect Get Organization Connect Configs — response body — error Detail
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
errorMessage | string | Optional | |
referenceId | string | Optional |
admin:Organization Connect Hmac Get Connect Hmac Secrets — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
secrets | array | Optional | |
secrets[] | string | Each item |
admin:Organization Connect O Auth Configuration Put Organization Connect O Auth Configuration — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authorizationServerUrl | string | Optional | Format: uri |
clientId | string | Optional | |
clientSecret | string | Optional | |
customParameter | object | Optional | Additional keys: see wildcard field |
customParameter.* | string | Additional keys | |
scope | string | Optional |