Accounts: listSharedAccess

Retrieves shared item status for one or more users and types of items.

Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared to shared_from.

Request

HTTP request

GET /v2/accounts/{accountId}/shared_access

Parameters

Parameter Name	Value	Description
Path Parameters
accountId	string	The external account number (int) or account ID Guid.
Optional Query Parameters
count	string	Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.
envelopes_not_shared_user_status	string
folder_ids	string	A comma separated list of folder IDs for which the shared item information is being requested. If `item_type` is `folders`, at least one folder ID is required.
item_type	string	Specifies the type of shared item being requested. The possible values are: `envelopes`: Get information about envelope sharing between users. `templates`: Get information about template sharing among users and groups. `folders`: Get information about folder sharing among users and groups.
search_text	string	This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string.
shared	string	A comma-separated list of sharing filters that specifies which users appear in the response. `not_shared`: The response contains users who do not share items of `item_type` with the current user. `shared_to`: The response contains users in `user_list` who are sharing items to current user. `shared_from`: The response contains users in `user_list` who are sharing items from the current user. `shared_to_and_from`: The response contains users in `user_list` who are sharing items to and sharing items from the current user. If the current user does not have administrative privileges, only the `shared_to` option is valid.
start_position	string	If the number of responses is greater than `count`, the number of responses to skip. Typically this value is a multiple of `count`. Default: 0.
user_ids	string	A comma-separated list of user IDs for whom the shared item information is being requested.

Responses

Code	Description	Reference
200	Successful response.	accountSharedAccess
400	Error encountered.	errorDetails

Code

Description

Reference

200

Successful response.

accountSharedAccess

400

Error encountered.

errorDetails

SDK Method

Accounts::listSharedAccess

Definitions

accountSharedAccess

Contains shared access information.
`accountId`	string	The account ID associated with the envelope.
`endPosition`	string	The last position in the result set.
`errorDetails`	errorDetails	A complex type containing an errorCode and message identifying the error that occurred.
`nextUri`	string	The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
`previousUri`	string	The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
`resultSetSize`	string	The number of results returned in this response.
`sharedAccess`	[memberSharedItems]	A list of shared access information of envelope and templates for the users specified in the request.
`startPosition`	string	Starting position of the current result set.
`totalSetSize`	string	The total number of items in the search's result set. It will always be greater than or equal to the value of the `resultSetSize` field.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode

string

An error code associated with the error.

message

string

A short error message.

group

Information about groups.
`errorDetails`	errorDetails
`groupId`	string	The DocuSign group ID for the group.
`groupName`	string	The name of the group.
`groupType`	string	The group type.
`permissionProfileId`	string	The ID of the permission profile associated with the group.
`users`	[userInfo]	List of users in the group.

memberGroupSharedItem

Information about items shared among groups.
`errorDetails`	errorDetails
`group`	group	The group sharing the item.
`shared`	string	How the item is shared. One of: `not_shared`: The item is not shared. `shared_to`: The item is shared.

memberSharedItems

Information about shared items.
`envelopes`	[sharedItem]	List of information about shared envelopes.
`errorDetails`	errorDetails
`templates`	[templateSharedItem]	List of information about shared templates.
`user`	userInfo	Information about the user requesting sharing information.

sharedItem

Information about the shared item.
`errorDetails`	errorDetails
`shared`	string	How the item is shared. One of: `not_shared` `shared_to` `shared_from` `shared_to_and_from`
`user`	userInfo	Information about the user associated with the shared item.

templateSharedItem

Information about shared templates.
`errorDetails`	errorDetails
`owner`	userInfo	The user who owns the template.
`shared`	string	How the template is shared. One of: `not_shared` `shared_to` `shared_from` `shared_to_and_from`
`sharedGroups`	[memberGroupSharedItem]	List of groups that share the template.
`sharedUsers`	[userSharedItem]	List of users that share the template.
`templateId`	string	The unique identifier of the template. If this is not provided, DocuSign will generate a value.
`templateName`	string	The name of the shared template.

userInfo


`activationAccessCode`	string
`email`	string
`errorDetails`	errorDetails
`loginStatus`	string
`sendActivationEmail`	string
`uri`	string
`userId`	string	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes `user_id` query parameter is not implemented and should not be used.
`userName`	string
`userStatus`	string	Status of the user's account. One of: ActivationRequired ActivationSent Active Closed Disabled
`userType`	string

userSharedItem

Information about a shared item.
`errorDetails`	errorDetails
`shared`	string	How the item is shared. One of: `not_shared` `shared_to` `shared_from` `shared_to_and_from`
`user`	userInfo	The user whose sharing information is being requested.

Examples

Generic JSON Response

Response

{
  "resultSetSize": "sample string 1",
  "totalSetSize": "sample string 2",
  "startPosition": "sample string 3",
  "endPosition": "sample string 4",
  "nextUri": "sample string 5",
  "previousUri": "sample string 6",
  "accountId": "sample string 7",
  "sharedAccess": [
    {
      "user": {
        "userName": "sample string 1",
        "userId": "sample string 2",
        "email": "sample string 3",
        "userType": "sample string 4",
        "userStatus": "sample string 5",
        "uri": "sample string 6",
        "loginStatus": "sample string 7",
        "sendActivationEmail": "sample string 8",
        "activationAccessCode": "sample string 9",
        "errorDetails": {
          "errorCode": "sample string 1",
          "message": "sample string 2"
        }
      },
      "envelopes": [
        {
          "user": {},
          "shared": "sample string 1",
          "errorDetails": {
            "errorCode": "SUCCESS",
            "message": ""
          }
        }
      ],
      "templates": [
        {
          "templateId": "sample string 1",
          "templateName": "sample string 2",
          "owner": {},
          "sharedUsers": [
            {
              "user": {},
              "errorDetails": {
                "errorCode": "SUCCESS",
                "message": ""
              },
              "shared": "sample string 1"
            }
          ],
          "sharedGroups": [
            {
              "group": {
                "groupId": "sample string 1",
                "groupName": "sample string 2",
                "permissionProfileId": "sample string 3",
                "groupType": "sample string 4",
                "users": [
                  {}
                ],
                "errorDetails": {
                  "errorCode": "SUCCESS",
                  "message": ""
                }
              },
              "errorDetails": {
                "errorCode": "SUCCESS",
                "message": ""
              },
              "shared": "sample string 1"
            }
          ],
          "errorDetails": {
            "errorCode": "SUCCESS",
            "message": ""
          }
        }
      ],
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      }
    }
  ],
  "errorDetails": {
    "errorCode": "SUCCESS",
    "message": ""
  }
}

Generic XML Response

Response

<accountSharedAccess xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <accountId>sample string 7</accountId>
  <endPosition>sample string 4</endPosition>
  <errorDetails>
    <errorCode>SUCCESS</errorCode>
    <message></message>
  </errorDetails>
  <nextUri>sample string 5</nextUri>
  <previousUri>sample string 6</previousUri>
  <resultSetSize>sample string 1</resultSetSize>
  <sharedAccess>
    <memberSharedItems>
      <envelopes>
        <sharedItem>
          <errorDetails>
            <errorCode>SUCCESS</errorCode>
            <message></message>
          </errorDetails>
          <shared>sample string 1</shared>
          <user />
        </sharedItem>
      </envelopes>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <templates>
        <templateSharedItem>
          <errorDetails>
            <errorCode>SUCCESS</errorCode>
            <message></message>
          </errorDetails>
          <owner />
          <sharedGroups>
            <memberGroupSharedItem>
              <errorDetails>
                <errorCode>SUCCESS</errorCode>
                <message></message>
              </errorDetails>
              <group>
                <errorDetails>
                  <errorCode>SUCCESS</errorCode>
                  <message></message>
                </errorDetails>
                <groupId>sample string 1</groupId>
                <groupName>sample string 2</groupName>
                <groupType>sample string 4</groupType>
                <permissionProfileId>sample string 3</permissionProfileId>
                <users>
                  <userInfo />
                </users>
              </group>
              <shared>sample string 1</shared>
            </memberGroupSharedItem>
          </sharedGroups>
          <sharedUsers>
            <userSharedItem>
              <errorDetails>
                <errorCode>SUCCESS</errorCode>
                <message></message>
              </errorDetails>
              <shared>sample string 1</shared>
              <user />
            </userSharedItem>
          </sharedUsers>
          <templateId>sample string 1</templateId>
          <templateName>sample string 2</templateName>
        </templateSharedItem>
      </templates>
      <user>
        <activationAccessCode>sample string 9</activationAccessCode>
        <email>sample string 3</email>
        <errorDetails>
          <errorCode>sample string 1</errorCode>
          <message>sample string 2</message>
        </errorDetails>
        <loginStatus>sample string 7</loginStatus>
        <sendActivationEmail>sample string 8</sendActivationEmail>
        <uri>sample string 6</uri>
        <userId>sample string 2</userId>
        <userName>sample string 1</userName>
        <userStatus>sample string 5</userStatus>
        <userType>sample string 4</userType>
      </user>
    </memberSharedItems>
  </sharedAccess>
  <startPosition>sample string 3</startPosition>
  <totalSetSize>sample string 2</totalSetSize>
</accountSharedAccess>

}} />