listUsersByWithHttpInfo method

Future<Response> listUsersByWithHttpInfo({
  1. String? startKey,
  2. String? startDocumentId,
  3. int? limit,
})

List users with(out) pagination

Returns a list of users.

Note: This method returns the HTTP Response.

Parameters:

  • String startKey: An user email

  • String startDocumentId: An user document ID

  • int limit: Number of rows

Implementation

Future<Response> listUsersByWithHttpInfo({ String? startKey, String? startDocumentId, int? limit, }) async {
  // ignore: prefer_const_declarations
  final path = r'/rest/v1/user';

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (startKey != null) {
    queryParams.addAll(_queryParams('', 'startKey', startKey));
  }
  if (startDocumentId != null) {
    queryParams.addAll(_queryParams('', 'startDocumentId', startDocumentId));
  }
  if (limit != null) {
    queryParams.addAll(_queryParams('', 'limit', limit));
  }

  const authNames = <String>[r'basicSchema'];
  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
    authNames,
  );
}