DocuSign: Gets a list of users in a DS Group
DocuSign admin.adminDocuSignGroupsv21GetDsgroupUsersV21: arguments, response, policy and SDK examples.
← Admin operations · Get started
Operation docusign.admin_docusigngroupsv21_getdsgroupusers_v2_1
Provider route: GET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users. 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"]["adminDocuSignGroupsv21GetDsgroupUsersV21"]>[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.adminDocuSignGroupsv21GetDsgroupUsersV21(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_docu_sign_groupsv21_get_dsgroup_users_v2_1(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.accountId | string | Required within parent | Format: uuid |
path.dsGroupId | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.page | integer | Optional | Format: int32 |
query.page_size | integer | Optional | Format: int32 |
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 a list of users in a DS Group — response body |
Referenced models: Gets a list of users in a DS Group — response body
Schemas
Section titled “Schemas”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
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]+)?$ |
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
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
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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.admin_docusigngroupsv21_getdsgroupusers_v2_1. Catalog operation: admin:DocuSignGroupsv21_GetDSGroupUsers_V2_1. 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: ["user_read"]