Skip to content

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.

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 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_docu_sign_groupsv21_get_dsgroup_users_v2_1(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.accountIdstringRequired within parentFormat: uuid
path.dsGroupIdstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.pageintegerOptionalFormat: int32
query.page_sizeintegerOptionalFormat: int32

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets a list of users in a DS Group — response body

Referenced models: Gets a list of users in a DS Group — response body

Gets a list of users in a DS Group — response body
FieldTypePresenceDescription and constraints
$objectRoot
groupModelOptionalExpand Creates a new DS Group — response body
group_usersModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
account_idstringOptionalSelect 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_namestringOptional
descriptionstringOptional
ds_group_idstringOptionalFormat: uuid
external_account_idJSONOptional
external_account_id (anyOf 1)integerAlternativeFormat: int64
external_account_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
group_idstringOptional
group_namestringOptional
is_adminbooleanOptional
is_managed_by_scimbooleanOptional
last_modified_onstringOptionalFormat: date-time
source_product_namestringOptional
user_countJSONOptional
user_count (anyOf 1)integerAlternativeFormat: int32
user_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Gets a list of users in a DS Group — response body — group users
FieldTypePresenceDescription and constraints
$objectRoot
pageJSONOptional
page (anyOf 1)integerAlternativeThe page number.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page_sizeJSONOptional
page_size (anyOf 1)integerAlternativeThe number of items per page.
Format: int32
page_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_countJSONOptional
total_count (anyOf 1)integerAlternativeFormat: int32
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
usersarrayOptionalA list of users.
users[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
account_idstringOptionalSelect 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_detailsModelOptionalExpand Updates a user's email address — response body — users item error details
Error results.
first_namestringOptionalThe user's first name.
last_namestringOptionalThe user's last name.
middle_namestringOptional
statusstringOptionalStatus.
user_idstringOptionalFormat: uuid
user_namestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootErrors.
errorstringOptionalThe code for the error.
error_descriptionstringOptionalA description of the error.

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

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.