$getUsers_Request method

@experimental Request $getUsers_Request({ String? search, int? limit, int? offset, bool? oCSAPIRequest, })

Get a list of users.

Returns a DynamiteRequest backing the getUsers operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• search Text to search for. Defaults to "".
• limit Limit the amount of groups returned.
• offset Offset for searching for groups. Defaults to 0.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Users returned

See:

• getUsers for a method executing this request and parsing the response.
• $getUsers_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $getUsers_Request({
  String? search,
  int? limit,
  int? offset,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  var $search = _$jsonSerializers.serialize(search, specifiedType: const FullType(String));
  $search ??= '';
  _parameters['search'] = $search;

  final $limit = _$jsonSerializers.serialize(limit, specifiedType: const FullType(int));
  _parameters['limit'] = $limit;

  var $offset = _$jsonSerializers.serialize(offset, specifiedType: const FullType(int));
  $offset ??= 0;
  _parameters['offset'] = $offset;

  final _path = _i5.UriTemplate('/ocs/v2.php/cloud/users{?search*,limit*,offset*}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}