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.
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"]["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 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_get_reserved_domains(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 |
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 Returns the list of reserved domains for the organization — response body |
Referenced models: Returns the list of reserved domains for the organization — response body
Schemas
Section titled “Schemas”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 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 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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]