Skip to content

DocuSign: Returns information about the users in an organization

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

← Admin operations · Get started

Operation docusign.admin_organizationuser_organizationusers_getv2

Provider route: GET /Management/v2/organizations/{organizationId}/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"]["adminOrganizationUserOrganizationUsersGetV2"]>[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.adminOrganizationUserOrganizationUsersGetV2(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_user_organization_users_get_v2(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
queryobjectOptionalAdditional keys: not allowed
query.startintegerOptionalFormat: int32
query.takeintegerOptionalFormat: int32
query.endintegerOptionalFormat: int32
query.emailstringOptional
query.email_user_name_likestringOptional
query.statusstringOptional
query.membership_statusstringOptional
query.account_idstringOptionalFormat: uuid
query.organization_reserved_domain_idstringOptionalFormat: uuid
query.last_modified_sincestringOptional
query.include_ds_groupsbooleanOptional
query.include_licensebooleanOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Returns information about the users in an organization — response body

Referenced models: Returns information about the users in an organization — response body

Returns information about the users in an organization — response body
FieldTypePresenceDescription and constraints
$objectRootA response containing information about users.
pagingModelOptionalExpand Returns the list of groups in an account — response body — paging
Contains information about paging through the results.
usersarrayOptionalA list of users.
users[]ModelEach itemExpand Returns information about the users in an organization — response body — users item

Referenced models: Returns information about the users in an organization — response body — users item, Returns the list of groups in an account — response body — paging

Returns information about the users in an organization — response body — users item
FieldTypePresenceDescription and constraints
$objectRootInformation about a user.
closed_onstringOptionalFormat: date-time
created_onstringOptionalThe date the user's account was created.
Format: date-time
ds_groupsarrayOptional
ds_groups[]ModelEach itemExpand Creates a new DS Group — response body
emailstringOptionalThe email address.
first_namestringOptionalThe user's first name.
idstringOptionalThe user's unique ID.
Format: uuid
is_managed_by_scimbooleanOptional
is_membership_managed_by_scimbooleanOptional
last_namestringOptionalThe user's last name.
license_typestringOptional
membership_closed_onstringOptionalFormat: date-time
membership_created_onstringOptionalThe date on which the user became a member of the organization.
Format: date-time
membership_idstringOptionalFormat: uuid
membership_statusstringOptionalThe user's membership status. One of:

- `activation_required`
- `activation_sent`
- `active`
- `closed`
- `disabled`
plan_namestringOptional
subscription_idstringOptional
user_namestringOptionalThe full name of the user.
user_statusstringOptionalThe user's status. One of:

- `active`
- `created`
- `closed`

Referenced models: Creates a new DS Group — response body

Returns the list of groups in an account — response body — paging
FieldTypePresenceDescription and constraints
$objectRoot
nextstringOptionalA URL to the next set of results.
previousstringOptionalA URL to the previous set of results.
result_set_end_positionJSONOptional
result_set_end_position (anyOf 1)integerAlternativeThe index position of the last result in this set.
Format: int32
result_set_end_position (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
result_set_sizeJSONOptional
result_set_size (anyOf 1)integerAlternativeThe number of items in a result set (page).
Format: int32
result_set_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
result_set_start_positionJSONOptional
result_set_start_position (anyOf 1)integerAlternativeThe index position of the first result in this set.
Format: int32
result_set_start_position (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_set_sizeJSONOptional
total_set_size (anyOf 1)integerAlternativeThe total number of results.
Format: int32
total_set_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
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]+)?$

SDK function policy ID: docusign.admin_organizationuser_organizationusers_getv2. Catalog operation: admin:OrganizationUser_OrganizationUsers_GetV2. 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.