docusign.connect-configurations.get-connect-all-users

Returns all users from the configured Connect service. <ds-inlinemessage> To use this method, you must be an account administrator and Connect must be enabled on your account. </ds-inlinemessage>

Returns all users from the configured Connect service.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
connectid	string	Yes	—	The ID of the custom Connect configuration being accessed.
count	string	No	—	The maximum number of results to return.
domain_users_only	string	No	—	—
email_substring	string	No	—	Filters returned user records by full email address or a substring of email address.
start_position	string	No	—	The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
status	string	No	—	The status of the item.
user_name_substring	string	No	—	Filters results based on a full or partial user name. Note: When you enter a partial user name, you do not use a wildcard character.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
connectid	string	Yes	—	The ID of the custom Connect configuration being accessed.
count	string	No	—	The maximum number of results to return.
domain_users_only	string	No	—	—
email_substring	string	No	—	Filters returned user records by full email address or a substring of email address.
start_position	string	No	—	The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
status	string	No	—	The status of the item.
user_name_substring	string	No	—	Filters results based on a full or partial user name. Note: When you enter a partial user name, you do not use a wildcard character.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call GET /v2.1/accounts/{accountId}/connect/{connectId}/all/users
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform GET /v2.1/accounts/{accountId}/connect/{connectId}/all/users
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.connect-configurations.get-connect-all-users",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "connectid": "value"
  }
}