Returns users from the configured Connect service.

Request

HTTP request

GET /v2/accounts/{accountId}/connect/{connectId}/users

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

connectIdstring

The ID of the custom Connect configuration being accessed.

Optional Query Parameters
countstring

Optional. Number of items to return.

email_substringstring

Filters the returned user records by the email address or a sub-string of email address.

list_included_usersstring

start_positionstring

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

statusstring

Filters the results by user status. You can specify a comma-separated list of the following statuses:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

user_name_substringstring

Filters the user records returned by the user name or a sub-string of user name.

Responses

CodeDescriptionReference
200

Successful response.

integratedUserInfoList
400

Error encountered.

errorDetails

SDK Method

Connect::connectUsers

Definitions

errorDetails

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

errorCodestring

An error code associated with the error.

messagestring

A short error message.

integratedUserInfoList

allUsersSelectedstring

endPositionstring

The last position in the result set.

nextUristring

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.

previousUristring

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.

resultSetSizestring

The number of results returned in this response.

startPositionstring

Starting position of the current result set.

totalSetSizestring

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.

users[userInfo]

userInfo

activationAccessCodestring

emailstring

errorDetailserrorDetails

loginStatusstring

sendActivationEmailstring

uristring

userIdstring

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.

userNamestring

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

Examples

Generic JSON Response

Response
{
  "allUsersSelected": "sample string 1",
  "users": [
    {
      "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"
      }
    }
  ],
  "resultSetSize": "sample string 2",
  "totalSetSize": "sample string 3",
  "startPosition": "sample string 4",
  "endPosition": "sample string 5",
  "nextUri": "sample string 6",
  "previousUri": "sample string 7"
}
Generic XML Response

Response
<integratedUserInfoList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <endPosition>sample string 5</endPosition>
  <nextUri>sample string 6</nextUri>
  <previousUri>sample string 7</previousUri>
  <resultSetSize>sample string 2</resultSetSize>
  <startPosition>sample string 4</startPosition>
  <totalSetSize>sample string 3</totalSetSize>
  <allUsersSelected>sample string 1</allUsersSelected>
  <users>
    <userInfo>
      <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>
    </userInfo>
  </users>
</integratedUserInfoList> 
}} />