Skip to content

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.

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 os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.admin.admin_organization_provision_asset_group_get_asset_group_account_clone(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.organizationIdstringRequired within parentFormat: uuid
path.assetGroupIdstringRequired within parentFormat: uuid
path.assetGroupWorkIdstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.include_detailsbooleanOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets information about a single cloned account — response body

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

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

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

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

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

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

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

Gets information about a single cloned account — response body — source Account
FieldTypePresenceDescription and constraints
$objectRoot
externalAccountIdJSONOptional
externalAccountId (anyOf 1)integerAlternativeThe external account ID of the source account.

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

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

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

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

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

Gets information about a single cloned account — response body — clone Processing Failure Details
FieldTypePresenceDescription and constraints
$objectRoot
errorstringOptionalThe error code.
Read only: true
errorDescriptionstringOptionalThe error description.
Read only: true
isSystemErrorbooleanOptionalWhether the error is caused by the system or user.
Read only: true
Gets information about a single cloned account — response body — target Account admin
FieldTypePresenceDescription and constraints
$objectRootAn object describing the administrator of the cloned account.
emailstringOptionalThe email address of the target account administrator. This property is required in the request body when cloning an account.
firstNamestringOptionalThe first name of the target account administrator. This property is required in the request body when cloning an account.
lastNamestringOptionalThe last name of the target account administrator. This property is required in the request body when cloning an account.
localestringOptionalThe locale of the target account administrator. The locale code for the United States is `en`.
Known values: None, zh_cn, zh_tw, nl, en, fr, de, it, ja, ko, pt, pt_br, ru, es, pl

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

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.