Connect Configurations

Returns all users from the configured Connect service

GET
/v2.1/accounts/{accountId}/connect/{connectId}/all/users

Returns all users from the configured Connect service.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

connectId*string

The ID of the custom Connect configuration being accessed.

Query Parameters

count?string

The maximum number of results to return.

domain_users_only?string
email_substring?string

Filters returned user records by full email address or a substring of email address.

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

The status of the item.

user_name_substring?string

Filters results based on a full or partial user name.

Note: When you enter a partial user name, you do not use a wildcard character.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/connect/string/all/users"
{  "endPosition": "string",  "nextUri": "string",  "previousUri": "string",  "resultSetSize": "string",  "startPosition": "string",  "totalSetSize": "string",  "users": [    {      "email": "string",      "isIncluded": "string",      "userId": "string",      "userName": "string"    }  ]}