Returns users from the configured Connect service.

Request

HTTP request

GET /v2.1/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 returned user records by full email address or a substring 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 returned user records by full user name or a substring 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

The code associated with the error condition.

messagestring

A brief message describing the error condition.

integratedUserInfoList

allUsersSelectedstring

endPositionstring

The last index 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 in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.

startPositionstring

The starting index position of the current result set.

totalSetSizestring

The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.

users[userInfo]

User management information.

userInfo

accountIdstring

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

accountNamestring

The name of the account associated with the current workspace user.

activationAccessCodestring

Access code provided to the user to activate the account.

emailstring

errorDetailserrorDetails

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

loginStatusstring

Boolean value that indicates whether the user is currently logged in or not.

membershipIdstring

The user's membership ID.

sendActivationEmailstring

When set to true, specifies that an activation email be sent to the user.

uristring

A URI containing the user ID.

userIdstring

The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, userId can represent another user whom the Administrator is accessing.

userNamestring

The name of the user.

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

The type of user, for example CompanyUser.

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> 
}} />