$editUser_Request method

  1. @experimental
Request $editUser_Request({
  1. required String userId,
  2. required UsersEditUserRequestApplicationJson $body,
  3. bool? oCSAPIRequest,
})

Update a value of the user's details.

This endpoint requires password confirmation.

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

Parameters:

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

Status codes:

  • 200: User value edited successfully

See:

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

Implementation

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

  final _path = _i6.UriTemplate('/ocs/v2.php/cloud/users/{userId}').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(UsersEditUserRequestApplicationJson)));
  return _request;
}