$addToGroup_Request method

@experimental Request $addToGroup_Request({ required String userId, String? groupid, bool? oCSAPIRequest, })

Add a user to a group.

This endpoint requires password confirmation.

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

Parameters:

• groupid ID of the group. Defaults to "".
• userId ID of the user.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: User added to group successfully

See:

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

Implementation

@_i2.experimental
_i3.Request $addToGroup_Request({
  required String userId,
  String? groupid,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $userId = _$jsonSerializers.serialize(userId, specifiedType: const FullType(String));
  _parameters['userId'] = $userId;

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

  final _path = _i5.UriTemplate('/ocs/v2.php/cloud/users/{userId}/groups{?groupid*}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _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;
}