SharedAccessEnvelopes
Retrieves the list of information about the shared envelopes.
The cmdlet will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the cmdlet.
- UserUserId supports the '=' and 'IN' operators.
- UserUserStatus supports the '=' operator.
- SearchText supports the '=' operator.
- Shared supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM SharedAccessEncelopes
Columns
| Name | Type | References | Description |
| UserUserId [KEY] | String | Information about the user who owns the shared item. The ID of the user to access. | |
| Shared | String | How the item is shared. One of: not_shared, shared_to, shared_from, shared_to_and_from. | |
| UserAccountId | String | Information about the user who owns the shared item. The account ID associated with the envelope. | |
| UserAccountName | String | Information about the user who owns the shared item. The name on the account. | |
| UserActivationAccessCode | String | Information about the user who owns the shared item. Access code provided to the user to activate the account. | |
| UserEmail | String | Information about the user who owns the shared item. The user's email address. | |
| UserIpAddress | String | Information about the user who owns the shared item. The user's ip address. | |
| UserLoginStatus | String | Information about the user who owns the shared item. When true, indicates that the user is logged in. | |
| UserMembershipId | String | Information about the user who owns the shared item. The user's membership ID. | |
| UserUri | String | Information about the user who owns the shared item. A URI containing the user ID. | |
| UserUserName | String | Information about the user who owns the shared item. The name of the user. | |
| UserUserStatus | String | Information about the user who owns the shared item. Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled. | |
| UserUserType | String | Information about the user who owns the shared item. The type of user. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| SearchText | String | Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string. |