DocuSign: Gets information about a single cloned account
DocuSign admin.adminOrganizationProvisionAssetGroupGetAssetGroupAccountClone: arguments, response, policy and SDK examples.
← Admin operations · Get started
Operation docusign.admin_organizationprovisionassetgroup_getassetgroupaccountclone
Provider route: GET /Management/v2/organizations/{organizationId}/assetGroups/{assetGroupId}/accountClones/{assetGroupWorkId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["admin"]["adminOrganizationProvisionAssetGroupGetAssetGroupAccountClone"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.admin.adminOrganizationProvisionAssetGroupGetAssetGroupAccountClone(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.admin.admin_organization_provision_asset_group_get_asset_group_account_clone(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.organizationId | string | Required within parent | Format: uuid |
path.assetGroupId | string | Required within parent | Format: uuid |
path.assetGroupWorkId | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.include_details | boolean | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Gets information about a single cloned account — response body |
Referenced models: Gets information about a single cloned account — response body
Schemas
Section titled “Schemas”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 — 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 — 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 — 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.admin_organizationprovisionassetgroup_getassetgroupaccountclone. Catalog operation: admin:OrganizationProvisionAssetGroup_GetAssetGroupAccountClone. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["asset_group_account_clone_read"]