Connect Configurations

Returns users from the configured Connect service

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

Returns 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.

Use start_position to specify the number of results to skip.

email_substring?string

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

list_included_users?string
start_position?string

The zero-based index of the result from which to start returning results.

Use with count to limit the number of results.

The default value is 0.

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 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/users"
{  "allUsersSelected": "string",  "endPosition": "string",  "nextUri": "string",  "previousUri": "string",  "resultSetSize": "string",  "startPosition": "string",  "totalSetSize": "string",  "users": [    {      "accountId": "string",      "accountName": "string",      "activationAccessCode": "string",      "email": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "ipAddress": "string",      "loginStatus": "string",      "membershipId": "string",      "sendActivationEmail": "string",      "uri": "string",      "userId": "string",      "userName": "string",      "userStatus": "string",      "userType": "string"    }  ]}