Returns users from the configured Connect service.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

connectId string

The ID of the custom Connect configuration being accessed.

Optional query parameters
count string

Optional. Number of items to return.

email_substring string

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

list_included_users string
start_position string

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

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

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
user_name_substring string

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

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Connect::listUsers

Definitions Expand All | Collapse All

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.

integratedUserInfoList

allUsersSelected string
endPosition string

The last position in the result set.

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.

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.

users
[userInfo]

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.

userName string
userStatus string

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
userType string

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>