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.
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"]["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 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_user_organization_users_get_v2(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 |
query | object | Optional | Additional keys: not allowed |
query.start | integer | Optional | Format: int32 |
query.take | integer | Optional | Format: int32 |
query.end | integer | Optional | Format: int32 |
query.email | string | Optional | |
query.email_user_name_like | string | Optional | |
query.status | string | Optional | |
query.membership_status | string | Optional | |
query.account_id | string | Optional | Format: uuid |
query.organization_reserved_domain_id | string | Optional | Format: uuid |
query.last_modified_since | string | Optional | |
query.include_ds_groups | boolean | Optional | |
query.include_license | boolean | Optional |
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 information about the users in an organization — response body |
Referenced models: Returns information about the users in an organization — response body
Schemas
Section titled “Schemas”Returns information about the users in an organization — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A response containing information about users. |
paging | Model | Optional | Expand Returns the list of groups in an account — response body — paging Contains information about paging through the results. |
users | array | Optional | A list of users. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a user. |
closed_on | string | Optional | Format: date-time |
created_on | string | Optional | The date the user's account was created. Format: date-time |
ds_groups | array | Optional | |
ds_groups[] | Model | Each item | Expand Creates a new DS Group — response body |
email | string | Optional | The email address. |
first_name | string | Optional | The user's first name. |
id | string | Optional | The user's unique ID. Format: uuid |
is_managed_by_scim | boolean | Optional | |
is_membership_managed_by_scim | boolean | Optional | |
last_name | string | Optional | The user's last name. |
license_type | string | Optional | |
membership_closed_on | string | Optional | Format: date-time |
membership_created_on | string | Optional | The date on which the user became a member of the organization. Format: date-time |
membership_id | string | Optional | Format: uuid |
membership_status | string | Optional | The user's membership status. One of: - `activation_required` - `activation_sent` - `active` - `closed` - `disabled` |
plan_name | string | Optional | |
subscription_id | string | Optional | |
user_name | string | Optional | The full name of the user. |
user_status | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
next | string | Optional | A URL to the next set of results. |
previous | string | Optional | A URL to the previous set of results. |
result_set_end_position | JSON | Optional | |
result_set_end_position (anyOf 1) | integer | Alternative | The index position of the last result in this set. Format: int32 |
result_set_end_position (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
result_set_size | JSON | Optional | |
result_set_size (anyOf 1) | integer | Alternative | The number of items in a result set (page). Format: int32 |
result_set_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
result_set_start_position | JSON | Optional | |
result_set_start_position (anyOf 1) | integer | Alternative | The index position of the first result in this set. Format: int32 |
result_set_start_position (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_set_size | JSON | Optional | |
total_set_size (anyOf 1) | integer | Alternative | The total number of results. Format: int32 |
total_set_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]