$modify_Request method
- @experimental
- required String configID,
- required ConfigapiModifyRequestApplicationJson $body,
- 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:
configID
ID of the config.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
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 String configID,
required ConfigapiModifyRequestApplicationJson $body,
bool? oCSAPIRequest,
}) {
final _parameters = <String, Object?>{};
final __configID = _$jsonSerializers.serialize(configID, specifiedType: const FullType(String));
_parameters['configID'] = __configID;
final _path = _i6.UriTemplate('/ocs/v2.php/apps/user_ldap/api/v1/config/{configID}').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 = _i4.IterableExtension(_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 _i5.HeaderEncoder().convert(__oCSAPIRequest);
_request.headers['Content-Type'] = 'application/json';
_request.body = json.encode(
_$jsonSerializers.serialize($body, specifiedType: const FullType(ConfigapiModifyRequestApplicationJson)),
);
return _request;
}