$modify_Request method

@experimental Request $modify_Request({ required ContentString<BuiltMap<String, JsonObject>> configData, required String configID, bool? oCSAPIRequest, })

Modify a configuration.

This endpoint requires admin access.

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

Parameters:

• configData New config.
• configID ID of the config.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Config returned
• 400: Modifying config is not possible
• 404: Config not found

See:

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

Implementation

@_i2.experimental
_i3.Request $modify_Request({
  required ContentString<BuiltMap<String, JsonObject>> configData,
  required String configID,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $configData = _$jsonSerializers.serialize(
    configData,
    specifiedType: const FullType(ContentString, [
      FullType(BuiltMap, [FullType(String), FullType(JsonObject)]),
    ]),
  );
  _parameters['configData'] = $configData;

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

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/user_ldap/api/v1/config/{configID}{?configData*}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('put', _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;
}