Skip to content

DocuSign: Returns the list of reserved domains for the organization

DocuSign admin.adminOrganizationGetReservedDomains: arguments, response, policy and SDK examples.

← Admin operations · Get started

Operation docusign.admin_organization_getreserveddomains

Provider route: GET /Management/v2/organizations/{organizationId}/reserved_domains. 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"]["adminOrganizationGetReservedDomains"]>[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.adminOrganizationGetReservedDomains(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_get_reserved_domains(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

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Returns the list of reserved domains for the organization — response body

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

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

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

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

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

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

Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
FieldTypePresenceDescription and constraints
$objectRootA link to a useful URL.
hrefstringOptionalThe URL of the linked item.
relstringOptionalThe kind of linked item.
Returns the list of reserved domains for the organization — response body — reserved domains item settings item
FieldTypePresenceDescription and constraints
$objectRootA key/value list of settings.
keystringOptionalThe key of the setting.
typestringOptionalThe type of the setting. One of:

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

SDK function policy ID: docusign.admin_organization_getreserveddomains. Catalog operation: admin:Organization_GetReservedDomains. 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: ["domain_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.